Skip to main content

• Introduction
  • Authentication
  • Idempotency
• Checkout Sessions
  • getFetch list of checkout sessions for a given account
  • postCreate a new checkout session
  • getFetch a specific checkout session
  • patchUpdate a checkout session
  • postExpire a check session
  • postSend checkout session link via SMS
  • postSend checkout session link via email
  • postSend checkout session receipt via email
• Payment Intents
  • postCreate a payment intent
  • getFetch a list of payment intents for an account
  • postSearch for payment intents
  • getFetch a payment intent for an account
  • patchPatch a payment intent
  • postCancel a payment intent
  • postCapture a payment intent
  • getFetch list of payments for a payment intent
  • postCreate a payment
  • postCreate a refund
  • postSend payment intent receipt via email
• Refunds
  • getFetch a refund by id
• Payment Methods
  • getFetch payment method
  • patchUpdate payment method
• External Payments
  • postCreate External Payment Intent
  • patchUpdate External Payment Intent
  • postCancel Payment Intent
  • postCapture External Payment
• External Refunds
  • postCreate External Refund
  • patchUpdate External Refund
  • postCancel External Refund
• Disputes
  • getFetch list of disputes matching query
  • getFetch dispute by id
• Balances
  • getFetch ledger account balances
• Transactions
  • getFetch a list of transactions
  • getFetch a transaction
  • postSearch a list of transactions
  • postDownload list of transactions
• Payouts
  • getFetch a list of payouts
  • getFetch a payout by id
  • getFetch a list of payouts for a business
• Payment Method Intents
  • postCreate a payment method intent
  • getFetch a payment method intents
  • getFetch a payment method intent
  • patchUpdate a payment method intent
  • postCancel a payment method intent
• Fees
  • getFetch a list of fees.
  • postCreate a fee.
  • getFetch a fee by id.
  • postRefund an adhoc fee.
• Payments
  • getFetch a payment by ID
• Surcharge
  • postCalculate surcharge fee for a payment
• Unmatched Settlements
  • getFetch a list of unmatched settlements.

API docs by Redocly](https://redocly.com/redoc/)

Payments API(v1.4.0)

Download OpenAPI specification: Download

Welcome to the Payments API documentation!

section/Introduction Introduction

This is the reference documentation and schemas for the Payments API.

section/Introduction/Authentication Authentication

The platform uses API Keys to manage access to the API. You can pass the API key in the x-api-key header to the request. Talk you your sales rep about acquiring these API keys. Authorization is done via headers. You should pass the api key as the value to the x-api-key header. For example, x-api-key: ${API_KEY}. Please note that you will be given 2 API keys, one public key and one private key. Use the private key for all server to server communication. The public key is used for interfacing wih the JS SDK.

section/Introduction/Idempotency Idempotency

The platform provides support for idempotency, a feature that allows requests to be safely retried without the risk of duplicate operations. This becomes particularly useful when an API call is interrupted during transmission, resulting in the absence of a response.

To execute an idempotent request, include the idempotency key in the x-idempotency-key header of the request. This key, which should be a unique value of at least 10 characters, is generated by the client. The method of creating this key is up to you, but we recommend using UUID v4 or any other string that has sufficient entropy to prevent overlaps.

Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result for a period of up to 1 hour.

Idempotency is only supported for POST and PUT requests.

tag/Checkout-Sessions Checkout Sessions

tag/Checkout-Sessions/operation/get_checkout_session_list Fetch list of checkout sessions for a given account

Use this endpoint to retrieve a paginated list of checkout sessions for a specific account. Checkout sessions are hosted payment forms that allow customers to complete payments. This endpoint is useful for monitoring session statuses, tracking conversion rates, and managing customer checkout experiences.

query Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/checkout_sessions

https://docs.getfwd.com/checkout\_sessions

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"entity": "checkout_session",

"url": "string",

"cancel_url": "string",

"success_url": "string",

"customer_email": "string",

"client_secret": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"items": [{"line_number": 0,

"material": "string",

"name": "string",

"description": "string",

"upc": 0,

"quantity": 0,

"uom": "string",

"unit_cost": 9007199254740991,

"net_amount": 9007199254740991,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"tax_exempt": true,

"discount_amount": 9007199254740991

}

],

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"currency": "USD"

},

"payment_intent_id": "string",

"status": "open",

"link_phone_number": "string",

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"account_id": "string",

"partner_id": "string",

"business_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Checkout-Sessions/operation/create_checkout_session Create a new checkout session

Use this endpoint to create a new hosted checkout session for customers. Checkout sessions provide a secure, branded payment experience where customers can enter payment information. You'll receive a URL that you can redirect customers to, and they'll be able to complete their payment securely.

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/checkout_sessions

https://docs.getfwd.com/checkout\_sessions

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"cancel_url": "string",

"success_url": "string",

"customer_email": "user@example.com",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"items": [{"line_number": 0,

"material": "string",

"name": "string",

"description": "string",

"upc": 0,

"quantity": 0,

"uom": "string",

"unit_cost": 9007199254740991,

"net_amount": 9007199254740991,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"tax_exempt": true,

"discount_amount": 9007199254740991

}

],

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

]

},

"google_pay_enabled": true,

"apple_pay_enabled": true,

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "checkout_session",

"url": "string",

"cancel_url": "string",

"success_url": "string",

"customer_email": "string",

"client_secret": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"currency": "USD"

},

"payment_intent_id": "string",

"status": "open",

"link_phone_number": "string",

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"account_id": "string",

"partner_id": "string",

"business_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}`

tag/Checkout-Sessions/operation/get_checkout_session Fetch a specific checkout session

path Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/checkout_sessions/{id}

https://docs.getfwd.com/checkout\_sessions/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "checkout_session",

"url": "string",

"cancel_url": "string",

"success_url": "string",

"customer_email": "string",

"client_secret": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"currency": "USD"

},

"payment_intent_id": "string",

"status": "open",

"link_phone_number": "string",

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"account_id": "string",

"partner_id": "string",

"business_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}`

tag/Checkout-Sessions/operation/update_checkout_session Update a checkout session

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/checkout_sessions/{id}

https://docs.getfwd.com/checkout\_sessions/{id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"customer_email": "user@example.com",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancel_url": "string",

"success_url": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

]

},

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"expires_at": "2019-08-24T14:15:22Z"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "checkout_session",

"url": "string",

"cancel_url": "string",

"success_url": "string",

"customer_email": "string",

"client_secret": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"currency": "USD"

},

"payment_intent_id": "string",

"status": "open",

"link_phone_number": "string",

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"account_id": "string",

"partner_id": "string",

"business_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}`

tag/Checkout-Sessions/operation/expire_checkout_session Expire a check session

path Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/checkout_sessions/{id}/expire

https://docs.getfwd.com/checkout\_sessions/{id}/expire

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "checkout_session",

"url": "string",

"cancel_url": "string",

"success_url": "string",

"customer_email": "string",

"client_secret": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"payment_intent_data": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"currency": "USD"

},

"payment_intent_id": "string",

"status": "open",

"link_phone_number": "string",

"surcharge": {"surcharge_enabled": true,

"surcharge_mode": "percentage",

"surcharge_percentage": 3,

"surcharge_fixed_amount": 0

},

"account_id": "string",

"partner_id": "string",

"business_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}`

tag/Checkout-Sessions/operation/send_checkout_session_sms Send checkout session link via SMS

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/checkout_sessions/{id}/send/sms

https://docs.getfwd.com/checkout\_sessions/{id}/send/sms

Request samples

• Payload

Content type

application/json

Copy

`{"phone_number": "string"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

`{"success": true,

"message": "string"

}`

tag/Checkout-Sessions/operation/send_checkout_session_email Send checkout session link via email

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/checkout_sessions/{id}/send/email

https://docs.getfwd.com/checkout\_sessions/{id}/send/email

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"cc_email_addresses": ["user@example.com"

],

"email_override": "user@example.com"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

`{"success": true,

"message": "string"

}`

tag/Checkout-Sessions/operation/send_checkout_session_receipt_email Send checkout session receipt via email

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/checkout_sessions/{id}/receipt/email

https://docs.getfwd.com/checkout\_sessions/{id}/receipt/email

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"cc_email_addresses": ["user@example.com"

],

"email_override": "user@example.com"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

`{"success": true,

"message": "string"

}`

tag/Payment-Intents Payment Intents

tag/Payment-Intents/operation/create_payment_intent Create a payment intent

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents

https://docs.getfwd.com/payment\_intents

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

]

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Intents/operation/get_payment_intents Fetch a list of payment intents for an account

query Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_intents

https://docs.getfwd.com/payment\_intents

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"items": [{"line_number": 0,

"material": "string",

"name": "string",

"description": "string",

"upc": 0,

"quantity": 0,

"uom": "string",

"unit_cost": 9007199254740991,

"net_amount": 9007199254740991,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"tax_exempt": true,

"discount_amount": 9007199254740991

}

],

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"items": [{"line_number": 0,

"material": "string",

"name": "string",

"description": "string",

"upc": 0,

"quantity": 0,

"uom": "string",

"unit_cost": 9007199254740991,

"net_amount": 9007199254740991,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"tax_exempt": true,

"discount_amount": 9007199254740991

}

],

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Payment-Intents/operation/search_payment_intent Search for payment intents

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/search

https://docs.getfwd.com/payment\_intents/search

Request samples

• Payload

Content type

application/json

Copy

`{"reference_id": "string",

"status": "created",

"settlement_status": "settled",

"payment_status": "processing",

"has_refund": true,

"start_date": "2019-08-24T14:15:22Z",

"end_date": "2019-08-24T14:15:22Z",

"created_at_start": "2019-08-24T14:15:22Z",

"created_at_end": "2019-08-24T14:15:22Z",

"updated_at_start": "2019-08-24T14:15:22Z",

"updated_at_end": "2019-08-24T14:15:22Z",

"settled_at_start": "2019-08-24T14:15:22Z",

"settled_at_end": "2019-08-24T14:15:22Z",

"amount_min": 0,

"amount_max": 0,

"sort_column": "amount",

"sort_direction": "asc",

"limit": 0,

"page": 0

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

"meta": {"limit": 0,

"page": 0,

"sort_column": "amount",

"sort_direction": "asc",

"reference_id": "string",

"status": "created",

"settlement_status": "settled",

"payment_status": "processing",

"has_refund": true,

"start_date": "2019-08-24T14:15:22Z",

"end_date": "2019-08-24T14:15:22Z",

"created_at_start": "2019-08-24T14:15:22Z",

"created_at_end": "2019-08-24T14:15:22Z",

"updated_at_start": "2019-08-24T14:15:22Z",

"updated_at_end": "2019-08-24T14:15:22Z",

"settled_at_start": "2019-08-24T14:15:22Z",

"settled_at_end": "2019-08-24T14:15:22Z",

"amount_min": 0,

"amount_max": 0

}

}`

tag/Payment-Intents/operation/get_payment_intent Fetch a payment intent for an account

path Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_intents/{id}

https://docs.getfwd.com/payment\_intents/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Intents/operation/update_payment_intent Patch a payment intent

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/payment_intents/{id}

https://docs.getfwd.com/payment\_intents/{id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Intents/operation/cancel_payment_intent Cancel a payment intent

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/{id}/cancel

https://docs.getfwd.com/payment\_intents/{id}/cancel

Request samples

• Payload

Content type

application/json

Copy

`{"cancellation_reason": "duplicate"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Intents/operation/capture_payment_intent Capture a payment intent

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/{id}/capture

https://docs.getfwd.com/payment\_intents/{id}/capture

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 0,

"merchant_amount": 0,

"payment_data": {"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

}

},

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

]

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Intents/operation/list_payments Fetch list of payments for a payment intent

path Parameters

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_intents/{id}/payments

https://docs.getfwd.com/payment\_intents/{id}/payments

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"items": [{"line_number": 0,

"material": "string",

"name": "string",

"description": "string",

"upc": 0,

"quantity": 0,

"uom": "string",

"unit_cost": 9007199254740991,

"net_amount": 9007199254740991,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"tax_exempt": true,

"discount_amount": 9007199254740991

}

],

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Payment-Intents/operation/create_payment Create a payment

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/{id}/payments

https://docs.getfwd.com/payment\_intents/{id}/payments

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"cvv2": "string",

"payment_method_id": "string",

"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/Payment-Intents/operation/create_refund Create a refund

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/{id}/refunds

https://docs.getfwd.com/payment\_intents/{id}/refunds

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 9007199254740991,

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

]

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "refund",

"status": "pending",

"currency": "USD",

"external": true,

"amount": 9007199254740991,

"account_id": "string",

"payment_id": "string",

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/Payment-Intents/operation/send_payment_intent_receipt_email Send payment intent receipt via email

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_intents/{id}/receipt/email

https://docs.getfwd.com/payment\_intents/{id}/receipt/email

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"cc_email_addresses": ["user@example.com"

],

"email_override": "user@example.com"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

`{"success": true,

"message": "string"

}`

tag/Refunds Refunds

tag/Refunds/operation/get_refund Fetch a refund by id

path Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/refunds/{id}

https://docs.getfwd.com/refunds/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "refund",

"status": "pending",

"currency": "USD",

"external": true,

"amount": 9007199254740991,

"account_id": "string",

"payment_id": "string",

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/Payment-Methods Payment Methods

tag/Payment-Methods/operation/get_payment_method Fetch payment method

path Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_methods/{id}

https://docs.getfwd.com/payment\_methods/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "ca_bank",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_intent_id": "string",

"payment_method_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"bank": {"masked_account": "string",

"masked_routing": "string",

"masked_institution": "string",

"masked_transit": "string",

"owner_type": "individual",

"account_id": "string",

"subtype": "string",

"name": "string",

"official_name": "string",

"type": "string",

"account_name": "string",

"country": "US",

"pad_agreement": {"accepted_at": "2019-08-24T14:15:22Z",

"ip": "string",

"agreement": "string"

}

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

}`

tag/Payment-Methods/operation/update_payment_method Update payment method

path Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/payment_methods/{id}

https://docs.getfwd.com/payment\_methods/{id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"exp_month": "string",

"exp_year": "string"

},

"meta_data": {"property1": null,

"property2": null

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "ca_bank",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_intent_id": "string",

"payment_method_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"bank": {"masked_account": "string",

"masked_routing": "string",

"masked_institution": "string",

"masked_transit": "string",

"owner_type": "individual",

"account_id": "string",

"subtype": "string",

"name": "string",

"official_name": "string",

"type": "string",

"account_name": "string",

"country": "US",

"pad_agreement": {"accepted_at": "2019-08-24T14:15:22Z",

"ip": "string",

"agreement": "string"

}

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

}`

tag/External-Payments External Payments

tag/External-Payments/operation/create_payment_intent_external Create External Payment Intent

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/external_payments

https://docs.getfwd.com/external\_payments

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"payment_intent": {"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

]

},

"payment_method": {"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string"

},

"meta_data": {"property1": null,

"property2": null

}

},

"payment": {"description": "string",

"reference_id": "string"

},

"gateway_response": {"auth_code": "string",

"retrieval_reference": "stringstring",

"invoice_number": "string",

"response_raw": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"card_present": true

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/External-Payments/operation/update_payment_intent_external Update External Payment Intent

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/external_payments/{payment_intent_id}

https://docs.getfwd.com/external\_payments/{payment\_intent\_id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"payment_method": {"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string"

},

"meta_data": {"property1": null,

"property2": null

}

},

"gateway_response": {"auth_code": "string",

"retrieval_reference": "stringstring",

"invoice_number": "string",

"response_raw": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"card_present": true

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/External-Payments/operation/cancel_payment_intent_external Cancel Payment Intent

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/external_payments/{payment_intent_id}/cancel

https://docs.getfwd.com/external\_payments/{payment\_intent\_id}/cancel

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"gateway_void_response": {"created_at": "2019-08-24T14:15:22Z",

"amount": 9007199254740991,

"response_raw": "string"

},

"cancellation_reason": "duplicate"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/External-Payments/operation/capture_external_payment Capture External Payment

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/external_payments/{payment_intent_id}/capture

https://docs.getfwd.com/external\_payments/{payment\_intent\_id}/capture

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"amount": 9007199254740991,

"gateway_capture_response": {"auth_code": "string",

"retrieval_reference": "stringstring",

"invoice_number": "string",

"response_raw": "string",

"created_at": "2019-08-24T14:15:22Z"

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_intent",

"status": "created",

"amount": 9007199254740991,

"merchant_amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"payment_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"capture": true,

"currency": "USD",

"latest_payment": {"id": "string",

"entity": "payment",

"status": "processing",

"currency": "USD",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"amount": 9007199254740991,

"amount_authorized": 9007199254740991,

"amount_captured": 9007199254740991,

"amount_refunded": 9007199254740991,

"amount_voided": 9007199254740991,

"amount_disputed": 9007199254740991,

"amount_reversed": 9007199254740991,

"amount_rejected": 9007199254740991,

"cvv": "M",

"avs": "A",

"address_line1_check": "pass",

"address_postal_code_check": "pass",

"cvv_check": "pass",

"signature": {"data": "string",

"gzipped": true,

"image_type": "binary",

"format": "png",

"dimensions": {"width": 0,

"height": 0

}

},

"return_code": "string",

"return_message": "string",

"failure_code": "string",

"failure_message": "string",

"cancelled_at": "2019-08-24T14:15:22Z",

"cancel_reason": "string",

"decline_category": "string",

"decline_category_text": "string",

"emv_tag_data": "string",

"entry_mode": "keyed",

"reversed": true,

"reversal_id": "string",

"reversal_expected": true,

"disputed": true,

"dispute_id": "string",

"order_details": {"card_not_present_type": "ecommerce",

"po_number": "string",

"tax_exempt": true,

"tax_amount": 9007199254740991,

"tip_amount": 9007199254740991,

"surcharge_amount": 9007199254740991,

"freight_amount": 9007199254740991,

"duty_amount": 9007199254740991,

"initiated_by": "merchant",

"is_scheduled_payment": true,

"order_date": "2019-08-24T14:15:22Z",

"ship_to_zip": "string",

"ship_from_zip": "string",

"ship_to_country": "st",

"invoice_id": "string",

"description": "string",

"subtotal": 9007199254740991,

"discount_amount": 9007199254740991,

"total": 9007199254740991

},

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"payment_intent_id": "string",

"payment_method_id": "string",

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"payment_rail_type": "card",

"payment_provider_type": "cardpointe",

"auth_code": "string",

"auth_response_text": "string",

"external": true,

"card_present": true,

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"account_id": "string",

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"description": "string",

"settlement_status": "settled",

"settled_at": "string"

},

"disputed": true,

"dispute_id": "string",

"reversed": true,

"reversal_id": "string",

"external": true,

"partner_id": "string",

"business_id": "string",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_rail_types": ["card"

],

"reference_id": "string",

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"description": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"cancelled_at": "2019-08-24T14:15:22Z",

"captured_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z"

}`

tag/External-Refunds External Refunds

tag/External-Refunds/operation/create_refund_external Create External Refund

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/external_refunds

https://docs.getfwd.com/external\_refunds

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"payment_intent_id": "string",

"refund_request": {"amount": 9007199254740991,

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

]

},

"gateway_response": {"created_at": "string",

"auth_code": "string",

"retrieval_reference": "stringstring",

"invoice_number": "string",

"response_raw": "string"

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "refund",

"status": "pending",

"currency": "USD",

"external": true,

"amount": 9007199254740991,

"account_id": "string",

"payment_id": "string",

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/External-Refunds/operation/update_refund_external Update External Refund

path Parameters

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/external_refunds/{refund_id}

https://docs.getfwd.com/external\_refunds/{refund\_id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"payment_intent_id": "string",

"refund_request": {"amount": 9007199254740991,

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

]

},

"gateway_response": {"created_at": "string",

"auth_code": "string",

"retrieval_reference": "stringstring",

"invoice_number": "string",

"response_raw": "string"

}

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "refund",

"status": "pending",

"currency": "USD",

"external": true,

"amount": 9007199254740991,

"account_id": "string",

"payment_id": "string",

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/External-Refunds/operation/cancel_refund_external Cancel External Refund

path Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/external_refunds/{refund_id}/cancel

https://docs.getfwd.com/external\_refunds/{refund\_id}/cancel

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "refund",

"status": "pending",

"currency": "USD",

"external": true,

"amount": 9007199254740991,

"account_id": "string",

"payment_id": "string",

"refund_splits": [{"account_id": "string",

"amount": 9007199254740991,

"description": "string"

}

],

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"settlement_status": "settled",

"settled_at": "string"

}`

tag/Disputes Disputes

tag/Disputes/operation/get_disputes Fetch list of disputes matching query

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/disputes

https://docs.getfwd.com/disputes

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"entity": "dispute",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"currency": "USD",

"account_id": "string",

"business_id": "string",

"status": "new",

"payment_id": "string",

"payment_intent_id": "string",

"amount": 9007199254740991,

"notes": [{"id": "string",

"message": "string",

"created_at": "2019-08-24T14:15:22Z",

"user_id": "string"

}

],

"attachments": [{"id": "string",

"description": "string",

"file_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"uploaded_by": "string",

"owner_id": "string"

}

],

"dispute_date": "2019-08-24",

"response_due_date": "2019-08-24",

"original_response_due_date": "2019-08-24",

"closed_date": "2019-08-24",

"dispute_received_date": "2019-08-24",

"disposition_date": "2019-08-24",

"reason_disputed_code": 0,

"reason_disputed": "string",

"dispute_response": "string",

"reference_meta": {"card_last_four": "string",

"merchant_id": "string",

"authorization_code": "string",

"transaction_date": "string",

"transaction_amount": 9007199254740991,

"retrieval_reference": "string"

},

"settlement_status": "settled",

"settled_at": "string"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Disputes/operation/get_dispute Fetch dispute by id

path Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/disputes/{id}

https://docs.getfwd.com/disputes/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "dispute",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"currency": "USD",

"account_id": "string",

"business_id": "string",

"status": "new",

"payment_id": "string",

"payment_intent_id": "string",

"amount": 9007199254740991,

"notes": [{"id": "string",

"message": "string",

"created_at": "2019-08-24T14:15:22Z",

"user_id": "string"

}

],

"attachments": [{"id": "string",

"description": "string",

"file_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"uploaded_by": "string",

"owner_id": "string"

}

],

"dispute_date": "2019-08-24",

"response_due_date": "2019-08-24",

"original_response_due_date": "2019-08-24",

"closed_date": "2019-08-24",

"dispute_received_date": "2019-08-24",

"disposition_date": "2019-08-24",

"reason_disputed_code": 0,

"reason_disputed": "string",

"dispute_response": "string",

"reference_meta": {"card_last_four": "string",

"merchant_id": "string",

"authorization_code": "string",

"transaction_date": "string",

"transaction_amount": 9007199254740991,

"retrieval_reference": "string"

},

"settlement_status": "settled",

"settled_at": "string"

}`

tag/Balances Balances

tag/Balances/operation/get_ledger_account_balances Fetch ledger account balances

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/balances

https://docs.getfwd.com/balances

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

`{"currency": "USD",

"pending": 9007199254740991,

"available": 9007199254740991

}`

tag/Transactions Transactions

tag/Transactions/operation/get_transactions Fetch a list of transactions

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/transactions

https://docs.getfwd.com/transactions

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"currency": "USD",

"data": [{"id": "string",

"entity": "transaction",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"ledger_account_id": "string",

"payout_id": "string",

"bank_transfer_id": "string",

"source_type": "dispute",

"source_id": "string",

"source_account_id": "string",

"root_source_id": "string",

"root_source_type": "adjustment",

"amount": 9007199254740991,

"currency": "USD",

"settlement_id": "string",

"settlement_status": "settled",

"settled_at": "string",

"description": "string",

"historical_bank_transfer_ids": ["string"

],

"historical_payout_ids": ["string"

]

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Transactions/operation/get_transaction Fetch a transaction

path Parameters

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/transactions/{id}

https://docs.getfwd.com/transactions/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "transaction",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"ledger_account_id": "string",

"payout_id": "string",

"bank_transfer_id": "string",

"source_type": "dispute",

"source_id": "string",

"source_account_id": "string",

"root_source_id": "string",

"root_source_type": "adjustment",

"amount": 9007199254740991,

"currency": "USD",

"settlement_id": "string",

"settlement_status": "settled",

"settled_at": "string",

"description": "string",

"historical_bank_transfer_ids": ["string"

],

"historical_payout_ids": ["string"

]

}`

tag/Transactions/operation/search_transactions Search a list of transactions

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/transactions/search

https://docs.getfwd.com/transactions/search

Request samples

• Payload

Content type

application/json

Copy

`{"root_source_id": "string",

"source_type": "dispute",

"settlement_status": "settled",

"start_date": "2019-08-24T14:15:22Z",

"end_date": "2019-08-24T14:15:22Z",

"created_at_start": "2019-08-24T14:15:22Z",

"created_at_end": "2019-08-24T14:15:22Z",

"updated_at_start": "2019-08-24T14:15:22Z",

"updated_at_end": "2019-08-24T14:15:22Z",

"settled_at_start": "2019-08-24T14:15:22Z",

"settled_at_end": "2019-08-24T14:15:22Z",

"sort_column": "updated_at",

"sort_direction": "asc",

"amount_min": 0,

"amount_max": 0,

"limit": 10,

"page": 1

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"entity": "transaction",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"ledger_account_id": "string",

"payout_id": "string",

"bank_transfer_id": "string",

"source_type": "dispute",

"source_id": "string",

"source_account_id": "string",

"root_source_id": "string",

"root_source_type": "adjustment",

"amount": 9007199254740991,

"currency": "USD",

"settlement_id": "string",

"settlement_status": "settled",

"settled_at": "string",

"description": "string",

"historical_bank_transfer_ids": ["string"

],

"historical_payout_ids": ["string"

]

}

],

"meta": {"limit": 10,

"page": 1,

"sort_column": "updated_at",

"sort_direction": "asc",

"root_source_id": "string",

"source_type": "dispute",

"settlement_status": "settled",

"start_date": "2019-08-24T14:15:22Z",

"end_date": "2019-08-24T14:15:22Z",

"created_at_start": "2019-08-24T14:15:22Z",

"created_at_end": "2019-08-24T14:15:22Z",

"updated_at_start": "2019-08-24T14:15:22Z",

"updated_at_end": "2019-08-24T14:15:22Z",

"settled_at_start": "2019-08-24T14:15:22Z",

"settled_at_end": "2019-08-24T14:15:22Z",

"amount_min": 0,

"amount_max": 0

}

}`

tag/Transactions/operation/download_transactions Download list of transactions

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/transactions/download

https://docs.getfwd.com/transactions/download

Request samples

• Payload

Content type

application/json

Copy

`{"root_source_id": "string",

"source_type": "dispute",

"settlement_status": "settled",

"start_date": "2019-08-24T14:15:22Z",

"end_date": "2019-08-24T14:15:22Z",

"created_at_start": "2019-08-24T14:15:22Z",

"created_at_end": "2019-08-24T14:15:22Z",

"updated_at_start": "2019-08-24T14:15:22Z",

"updated_at_end": "2019-08-24T14:15:22Z",

"settled_at_start": "2019-08-24T14:15:22Z",

"settled_at_end": "2019-08-24T14:15:22Z",

"sort_column": "updated_at",

"sort_direction": "asc",

"amount_min": 0,

"amount_max": 0

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy

{ }

tag/Payouts Payouts

tag/Payouts/operation/get_payouts Fetch a list of payouts

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payouts

https://docs.getfwd.com/payouts

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"entity": "payout",

"status": "created",

"payout_number": 0,

"transaction_count": 0,

"transaction_summary": [{"type": "dispute",

"count": 0,

"amount": 9007199254740991

}

],

"amount": 9007199254740991,

"net_amount": 9007199254740991,

"fee_amount": 9007199254740991,

"batch_fee": 9007199254740991,

"reject_fee": 9007199254740991,

"latest_payment_data": {"id": "string",

"trace_number": "string",

"service_type": "standard",

"description": "string",

"bank_account_number_mask": "string",

"bank_account_type": "checking",

"bank_account_id": "string",

"status": "created",

"payment_type": "origination",

"direction": "inbound",

"reason_code": "string",

"reason_data": "string",

"updated_at": "2019-08-24T14:15:22Z",

"type": "cross_river_bank",

"reference_id": "string",

"sec_code": "string"

},

"payment_data": [{"id": "string",

"trace_number": "string",

"service_type": "standard",

"description": "string",

"bank_account_number_mask": "string",

"bank_account_type": "checking",

"bank_account_id": "string",

"status": "created",

"payment_type": "origination",

"direction": "inbound",

"reason_code": "string",

"reason_data": "string",

"updated_at": "2019-08-24T14:15:22Z",

"type": "cross_river_bank",

"reference_id": "string",

"sec_code": "string"

}

],

"payment_attempt_count": 0,

"payment_reject_count": 0,

"owner_type": "account",

"owner_id": "string",

"ledger_type": "operating",

"currency": "USD",

"business_id": "string",

"batch_window": {"window_start": "2019-08-24T14:15:22Z",

"window_end": "2019-08-24T14:15:22Z",

"delay_until": "2019-08-24T14:15:22Z",

"size": 0,

"size_type": "day",

"strict": true

},

"gross_funding_type": "fee_activity",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"completed_at": "2019-08-24T14:15:22Z",

"returned_at": "2019-08-24T14:15:22Z"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Payouts/operation/get_payout Fetch a payout by id

path Parameters

query Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payouts/{id}

https://docs.getfwd.com/payouts/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entity": "payout",

"status": "created",

"payout_number": 0,

"transaction_count": 0,

"transaction_summary": [{"type": "dispute",

"count": 0,

"amount": 9007199254740991

}

],

"amount": 9007199254740991,

"net_amount": 9007199254740991,

"fee_amount": 9007199254740991,

"batch_fee": 9007199254740991,

"reject_fee": 9007199254740991,

"latest_payment_data": {"id": "string",

"trace_number": "string",

"service_type": "standard",

"description": "string",

"bank_account_number_mask": "string",

"bank_account_type": "checking",

"bank_account_id": "string",

"status": "created",

"payment_type": "origination",

"direction": "inbound",

"reason_code": "string",

"reason_data": "string",

"updated_at": "2019-08-24T14:15:22Z",

"type": "cross_river_bank",

"reference_id": "string",

"sec_code": "string"

},

"payment_data": [{"id": "string",

"trace_number": "string",

"service_type": "standard",

"description": "string",

"bank_account_number_mask": "string",

"bank_account_type": "checking",

"bank_account_id": "string",

"status": "created",

"payment_type": "origination",

"direction": "inbound",

"reason_code": "string",

"reason_data": "string",

"updated_at": "2019-08-24T14:15:22Z",

"type": "cross_river_bank",

"reference_id": "string",

"sec_code": "string"

}

],

"payment_attempt_count": 0,

"payment_reject_count": 0,

"owner_type": "account",

"owner_id": "string",

"ledger_type": "operating",

"currency": "USD",

"business_id": "string",

"batch_window": {"window_start": "2019-08-24T14:15:22Z",

"window_end": "2019-08-24T14:15:22Z",

"delay_until": "2019-08-24T14:15:22Z",

"size": 0,

"size_type": "day",

"strict": true

},

"gross_funding_type": "fee_activity",

"settlement_status": "settled",

"settled_at": "2019-08-24T14:15:22Z",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"completed_at": "2019-08-24T14:15:22Z",

"returned_at": "2019-08-24T14:15:22Z"

}`

tag/Payouts/operation/get_payouts_by_business Fetch a list of payouts for a business

query Parameters

header Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/businesses/payouts

https://docs.getfwd.com/businesses/payouts

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Payment-Method-Intents Payment Method Intents

tag/Payment-Method-Intents/operation/create_payment_method_intent Create a payment method intent

Use this endpoint to create a new payment method intent for securely collecting and validating payment method information. Payment method intents provide a secure way to collect card or bank account details from customers. You can create them with or without payment method data, and they support validation to ensure the payment method is valid before storing.

header Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_method_intents

https://docs.getfwd.com/payment\_method\_intents

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"payment_method_data": {"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"token": "string",

"device_serial_number": "string",

"reuse_eligible": true

},

"client_secret": "string",

"meta_data": {"property1": null,

"property2": null

},

"persist_on_validation_failure": true

},

"payment_method_types": ["card"

],

"user_fields": {"property1": null,

"property2": null

},

"validate": true,

"bill_to": "merchant"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_method_intent",

"status": "created",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"validate": true,

"bill_to": "merchant",

"latest_validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"validation_attempts": [{"response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"payment_method": {"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"token": "string",

"device_serial_number": "string",

"reuse_eligible": true

},

"client_secret": "string",

"meta_data": {"property1": null,

"property2": null

},

"persist_on_validation_failure": true

}

}

],

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Method-Intents/operation/get_payment_method_intents Fetch a payment method intents

Use this endpoint to retrieve a paginated list of payment method intents for an account. This is useful for monitoring the status of payment method creation requests, tracking validation attempts, and managing the lifecycle of payment method setup processes.

query Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_method_intents

https://docs.getfwd.com/payment\_method\_intents

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"id": "string",

"client_secret": "string",

"entity": "payment_method_intent",

"status": "created",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"validate": true,

"bill_to": "merchant",

"latest_validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"validation_attempts": [{"response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"payment_method": {"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "stri",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"token": "string",

"device_serial_number": "string",

"reuse_eligible": true

},

"client_secret": "string",

"meta_data": {"property1": null,

"property2": null

},

"persist_on_validation_failure": true

}

}

],

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z"

}

],

"meta": {"has_more": true,

"limit": 0

}

}`

tag/Payment-Method-Intents/operation/get_payment_method_intent Fetch a payment method intent

Use this endpoint to retrieve details about a specific payment method intent by its ID. This returns information about the payment method creation process, validation status, and any associated payment method data. Useful for checking the status of a payment method setup request.

path Parameters

Responses

200 Default Response

4XX Default Response

5XX Default Response

get/payment_method_intents/{id}

https://docs.getfwd.com/payment\_method\_intents/{id}

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_method_intent",

"status": "created",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"validate": true,

"bill_to": "merchant",

"latest_validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Method-Intents/operation/update_payment_method_intent Update a payment method intent

path Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

patch/payment_method_intents/{id}

https://docs.getfwd.com/payment\_method\_intents/{id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"user_fields": {"property1": null,

"property2": null

},

"payment_method_types": ["card"

]

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_method_intent",

"status": "created",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"validate": true,

"bill_to": "merchant",

"latest_validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

},

"user_fields": {"property1": null,

"property2": null

},

"cancellation_reason": "string",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z"

}`

tag/Payment-Method-Intents/operation/cancel_payment_method_intent Cancel a payment method intent

path Parameters

Request Body schema: application/json

Responses

200 Default Response

4XX Default Response

5XX Default Response

post/payment_method_intents/{id}/cancel

https://docs.getfwd.com/payment\_method\_intents/{id}/cancel

Request samples

• Payload

Content type

application/json

Copy

`{"cancellation_reason": "string"

}`

Response samples

• 200
• 4XX
• 5XX

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"client_secret": "string",

"entity": "payment_method_intent",

"status": "created",

"account_id": "string",

"payment_method_types": ["card"

],

"payment_method": {"id": "string",

"entity": "payment_method",

"created_at": "2019-08-24T14:15:22Z",

"updated_at": "2019-08-24T14:15:22Z",

"payment_method_type": "card",

"source_type": "cardpointe",

"billing_details": {"address": {"city": "string",

"country": "string",

"state": "string",

"address_line1": "string",

"address_line2": "string",

"postal_code": "string"

},

"email": "string",

"name": "string",

"phone": "string"

},

"payment_method_intent_id": "string",

"payment_intent_id": "string",

"checkout_session_id": "string",

"single_use_token": true,

"signature": "string",

"card": {"last_four_digits": "string",

"first_six_digits": "string",

"brand": "visa",

"exp_month": "string",

"exp_year": "string",

"wallet": "apple_pay",

"entry_mode": "keyed",

"from_terminal": true,

"device_serial_number": "string",

"reuse_eligible": true

},

"meta_data": {"property1": null,

"property2": null

},

"validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",

"auth_code": "string",

"token": "string",

"gateway_response": {"code": "string",

"text": "string",

"source": "string"

},

"decline_category": "string",

"decline_category_text": "string"

}

},

"validate": true,

"bill_to": "merchant",

"latest_validation_response": {"status": "succeeded",

"message": "string",

"created_at": "string",