Skip to main content
API docs by Redocly

Payments API (v1.4.0)

Download OpenAPI specification:Download

Welcome to the Payments API documentation!

Introduction

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

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.

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.

Checkout Sessions

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
ending_before
string

The id of the entity, use to sort in reverse order

starting_after
string

The id of the entity

limit
number
Default: 10

Max value is 50

header Parameters
x-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new checkout session

header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
cancel_url
string <= 500 characters
success_url
string <= 500 characters
customer_email
string <email> <= 255 characters
reference_id
string <= 300 characters
object
payment_method_types
Array of strings
Items Enum: "card" "bank"
required
object (PaymentIntentCreateRequestDTO)
google_pay_enabled
boolean
Default: true
apple_pay_enabled
boolean
Default: true
CheckoutSessionSurchargePercentageDTO (object) or CheckoutSessionSurchargeFixedDTO (object) or CheckoutSessionSurchargeDisabledDTO (object)

Responses

Request samples

Content type
application/json
{
  • "cancel_url": "string",
  • "success_url": "string",
  • "customer_email": "user@example.com",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "google_pay_enabled": true,
  • "apple_pay_enabled": true,
  • "surcharge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "checkout_session",
  • "url": "string",
  • "cancel_url": "string",
  • "success_url": "string",
  • "customer_email": "string",
  • "client_secret": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "payment_intent_id": "string",
  • "status": "open",
  • "link_phone_number": "string",
  • "surcharge": {
    },
  • "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"
}

Fetch a specific checkout session

path Parameters
id
required
string
header Parameters
x-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "checkout_session",
  • "url": "string",
  • "cancel_url": "string",
  • "success_url": "string",
  • "customer_email": "string",
  • "client_secret": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "payment_intent_id": "string",
  • "status": "open",
  • "link_phone_number": "string",
  • "surcharge": {
    },
  • "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"
}

Update a checkout session

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
customer_email
string <email> <= 255 characters
reference_id
string <= 300 characters
object
cancel_url
string <= 500 characters
success_url
string <= 500 characters
payment_method_types
Array of strings
Items Enum: "card" "bank"
object
subtotal
integer [ 0 .. 9007199254740991 ]
discount_amount
integer [ 0 .. 9007199254740991 ]
object or object or object
expires_at
string <date-time>

Expiration date-time for the checkout session. Must be in the future and within the maximum allowed expiration window.

Responses

Request samples

Content type
application/json
{
  • "customer_email": "user@example.com",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "cancel_url": "string",
  • "success_url": "string",
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "subtotal": 9007199254740991,
  • "discount_amount": 9007199254740991,
  • "surcharge": {
    },
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "checkout_session",
  • "url": "string",
  • "cancel_url": "string",
  • "success_url": "string",
  • "customer_email": "string",
  • "client_secret": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "payment_intent_id": "string",
  • "status": "open",
  • "link_phone_number": "string",
  • "surcharge": {
    },
  • "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"
}

Expire a check session

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "checkout_session",
  • "url": "string",
  • "cancel_url": "string",
  • "success_url": "string",
  • "customer_email": "string",
  • "client_secret": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "payment_method_types": [
    ],
  • "payment_intent_data": {
    },
  • "payment_intent_id": "string",
  • "status": "open",
  • "link_phone_number": "string",
  • "surcharge": {
    },
  • "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"
}

Send checkout session link via SMS

path Parameters
id
required
string
header Parameters
x-account-id
required
string
Request Body schema: application/json
phone_number
required
string^\+[1-9]\d{1,14}$

Phone number in E.164 format (e.g., +18883456789)

Responses

Request samples

Content type
application/json
{
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Send checkout session link via email

path Parameters
id
required
string
header Parameters
x-account-id
required
string
Request Body schema: application/json
cc_email_addresses
Array of strings <email>

Array of email addresses to send checkout session to

email_override
string <email>

Responses

Request samples

Content type
application/json
{
  • "cc_email_addresses": [
    ],
  • "email_override": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Send checkout session receipt via email

path Parameters
id
required
string
header Parameters
x-account-id
required
string
Request Body schema: application/json
cc_email_addresses
Array of strings <email>

Array of email addresses to send checkout session to

email_override
string <email>

Responses

Request samples

Content type
application/json
{
  • "cc_email_addresses": [
    ],
  • "email_override": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Payment Intents

Create a payment intent

header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
required
integer [ 0 .. 9007199254740991 ]
merchant_amount
integer [ 0 .. 9007199254740991 ]
Array of objects
object
capture
boolean
reference_id
string <= 300 characters
object
description
string <= 1000 characters
payment_method_types
Array of strings
Items Enum: "card" "bank"

Responses

Request samples

Content type
application/json
{
  • "amount": 9007199254740991,
  • "merchant_amount": 9007199254740991,
  • "payment_splits": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "reference_id": "string",
  • "user_fields": {
    },
  • "description": "string",
  • "payment_method_types": [
    ]
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Fetch a list of payment intents for an account

query Parameters
ending_before
string

The id of the entity, use to sort in reverse order

starting_after
string

The id of the entity

limit
number
Default: 10

Max value is 50

header Parameters
x-account-id
string
x-business-id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Search for payment intents

header Parameters
x-account-id
string
x-business-id
string
Request Body schema: application/json
reference_id
string
status
string
Enum: "created" "processing" "pending" "uncaptured" "captured" "cancelled" "failed"
settlement_status
string
Enum: "settled" "unsettled"
payment_status
string
Enum: "processing" "pending" "uncaptured" "captured" "cancelled" "voided" "failed" "rejected"
has_refund
boolean
start_date
string <date-time>
Deprecated
end_date
string <date-time>
Deprecated
created_at_start
string <date-time>
created_at_end
string <date-time>
updated_at_start
string <date-time>
updated_at_end
string <date-time>
settled_at_start
string <date-time>
settled_at_end
string <date-time>
amount_min
integer
amount_max
integer
string or string or string or string or string or string or string
sort_direction
string
Enum: "asc" "desc"
limit
integer
page
integer

Responses

Request samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fetch a payment intent for an account

path Parameters
id
required
string
header Parameters
x-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Patch a payment intent

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
integer [ 0 .. 9007199254740991 ]
merchant_amount
integer [ 0 .. 9007199254740991 ]
Array of objects
object
capture
boolean
payment_method_types
Array of strings
Items Enum: "card" "bank"
reference_id
string <= 300 characters
object
description
string <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "amount": 9007199254740991,
  • "merchant_amount": 9007199254740991,
  • "payment_splits": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Cancel a payment intent

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
cancellation_reason
string
Enum: "duplicate" "fraudulent" "requested_by_customer" "abandoned"

Responses

Request samples

Content type
application/json
{
  • "cancellation_reason": "duplicate"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Capture a payment intent

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
integer (Amount to capture) >= 0

Amount charged to the cardholder

merchant_amount
integer (Merchant Amount) >= 0

Amount to be credited to the merchant (Advanced Plan only)

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "merchant_amount": 0,
  • "payment_data": {
    },
  • "payment_splits": [
    ]
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Fetch list of payments for a payment intent

path Parameters
id
required
string
query Parameters
ending_before
string

The id of the entity, use to sort in reverse order

starting_after
string

The id of the entity

limit
number
Default: 10

Max value is 50

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a payment

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
reference_id
string
object
description
string
object
cvv2
string
payment_method_id
required
string
object

Responses

Request samples

Content type
application/json
{
  • "reference_id": "string",
  • "user_fields": {
    },
  • "description": "string",
  • "order_details": {
    },
  • "cvv2": "string",
  • "payment_method_id": "string",
  • "billing_details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "payment",
  • "status": "processing",
  • "currency": "USD",
  • "billing_details": {
    },
  • "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": {
    },
  • "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": {
    },
  • "gateway_response": {
    },
  • "payment_intent_id": "string",
  • "payment_method_id": "string",
  • "payment_method": {
    },
  • "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": {
    },
  • "description": "string",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Create a refund

path Parameters
id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
integer [ 0 .. 9007199254740991 ]
Array of objects

Responses

Request samples

Content type
application/json
{
  • "amount": 9007199254740991,
  • "refund_splits": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "refund",
  • "status": "pending",
  • "currency": "USD",
  • "external": true,
  • "amount": 9007199254740991,
  • "account_id": "string",
  • "payment_id": "string",
  • "refund_splits": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Send payment intent receipt via email

path Parameters
id
required
string
header Parameters
x-account-id
required
string
Request Body schema: application/json
cc_email_addresses
Array of strings <email>

Array of email addresses to send payment intent receipt to

email_override
string <email>

Responses

Request samples

Content type
application/json
{
  • "cc_email_addresses": [
    ],
  • "email_override": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Refunds

Fetch a refund by id

path Parameters
id
required
string
header Parameters
x-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "refund",
  • "status": "pending",
  • "currency": "USD",
  • "external": true,
  • "amount": 9007199254740991,
  • "account_id": "string",
  • "payment_id": "string",
  • "refund_splits": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Payment Methods

Fetch payment method

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "payment_method",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_method_type": "bank",
  • "source_type": "cardpointe",
  • "billing_details": {
    },
  • "payment_intent_id": "string",
  • "payment_method_intent_id": "string",
  • "checkout_session_id": "string",
  • "single_use_token": true,
  • "signature": "string",
  • "bank": {
    },
  • "meta_data": {
    },
  • "validation_response": {
    }
}

Update payment method

path Parameters
id
required
string
Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "billing_details": {
    },
  • "card": {
    },
  • "meta_data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "payment_method",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_method_type": "bank",
  • "source_type": "cardpointe",
  • "billing_details": {
    },
  • "payment_intent_id": "string",
  • "payment_method_intent_id": "string",
  • "checkout_session_id": "string",
  • "single_use_token": true,
  • "signature": "string",
  • "bank": {
    },
  • "meta_data": {
    },
  • "validation_response": {
    }
}

External Payments

Create External Payment Intent

header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
required
object
required
object
object
required
object
card_present
boolean

Responses

Request samples

Content type
application/json
{
  • "payment_intent": {
    },
  • "payment_method": {
    },
  • "payment": {
    },
  • "gateway_response": {
    },
  • "card_present": true
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Update External Payment Intent

path Parameters
payment_intent_id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
integer <= 9007199254740991
merchant_amount
integer <= 9007199254740991
object (ExternalPaymentMethodCreateRequestDTO)
object
card_present
boolean

Responses

Request samples

Content type
application/json
{
  • "amount": 9007199254740991,
  • "merchant_amount": 9007199254740991,
  • "payment_method": {
    },
  • "gateway_response": {
    },
  • "card_present": true
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Cancel Payment Intent

path Parameters
payment_intent_id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
object
cancellation_reason
string
Enum: "duplicate" "fraudulent" "requested_by_customer" "abandoned"

Responses

Request samples

Content type
application/json
{
  • "gateway_void_response": {
    },
  • "cancellation_reason": "duplicate"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

Capture External Payment

path Parameters
payment_intent_id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
amount
integer <= 9007199254740991
required
object

Responses

Request samples

Content type
application/json
{
  • "amount": 9007199254740991,
  • "gateway_capture_response": {
    }
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "order_details": {
    },
  • "capture": true,
  • "currency": "USD",
  • "latest_payment": {
    },
  • "disputed": true,
  • "dispute_id": "string",
  • "reversed": true,
  • "reversal_id": "string",
  • "external": true,
  • "partner_id": "string",
  • "business_id": "string",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "reference_id": "string",
  • "user_fields": {
    },
  • "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"
}

External Refunds

Create External Refund

header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
payment_intent_id
required
string
object (RefundRequestDTO)
required
object

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "string",
  • "refund_request": {
    },
  • "gateway_response": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "refund",
  • "status": "pending",
  • "currency": "USD",
  • "external": true,
  • "amount": 9007199254740991,
  • "account_id": "string",
  • "payment_id": "string",
  • "refund_splits": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Update External Refund

path Parameters
refund_id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
payment_intent_id
required
string
object (RefundRequestDTO)
required
object

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "string",
  • "refund_request": {
    },
  • "gateway_response": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "refund",
  • "status": "pending",
  • "currency": "USD",
  • "external": true,
  • "amount": 9007199254740991,
  • "account_id": "string",
  • "payment_id": "string",
  • "refund_splits": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Cancel External Refund

path Parameters
refund_id
required
string
header Parameters
x-account-id
required
string
x-idempotency-key
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "refund",
  • "status": "pending",
  • "currency": "USD",
  • "external": true,
  • "amount": 9007199254740991,
  • "account_id": "string",
  • "payment_id": "string",
  • "refund_splits": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Disputes

Fetch list of disputes matching query

query Parameters
starting_after
string
ending_before
string
string or string or string or string or string or string
limit
number <= 50
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fetch dispute by id

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "attachments": [
    ],
  • "dispute_date": "2019-08-24",
  • "response_due_date": "2019-08-24",
  • "original_response_due_date": "2019-08-24",
  • "closed_date": "2019-08-24",
  • "reason_disputed_code": 0,
  • "reason_disputed": "string",
  • "dispute_response": "string",
  • "reference_meta": {
    },
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Balances

Fetch ledger account balances

query Parameters
ledger_type
string
Enum: "operating" "funding"
currency
string
Enum: "USD" "CAD"

Responses

Response samples

Content type
application/json
{
  • "currency": "USD",
  • "pending": 9007199254740991,
  • "available": 9007199254740991
}

Transactions

Fetch a list of transactions

query Parameters
ending_before
string
starting_after
string
limit
number
payout_id
string
currency
string
Enum: "USD" "CAD"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fetch a transaction

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "historical_payout_ids": [
    ]
}

Search a list of transactions

Request Body schema: application/json
root_source_id
string

The root source ID of the transaction, typically the ID of a payment, refund or dispute. For example, passing a payment id will return all balance transactions that are related to that payment (fees, transfers, etc.).

source_type
string
Enum: "dispute" "fee" "fee_refund" "funding" "payment" "payment_method" "payout" "refund" "refund_failure" "transfer" "reversal" "transaction"
settlement_status
string
Enum: "settled" "unsettled"
start_date
string <date-time>
Deprecated
end_date
string <date-time>
Deprecated
created_at_start
string <date-time>
created_at_end
string <date-time>
updated_at_start
string <date-time>
updated_at_end
string <date-time>
settled_at_start
string <date-time>
settled_at_end
string <date-time>
string or string or string or string or string
Default: "updated_at"
sort_direction
string
Enum: "asc" "desc"
amount_min
integer
amount_max
integer
limit
integer <= 50
Default: 10
page
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Download list of transactions

Request Body schema: application/json
root_source_id
string

The root source ID of the transaction, typically the ID of a payment, refund or dispute. For example, passing a payment id will return all balance transactions that are related to that payment (fees, transfers, etc.).

source_type
string
Enum: "dispute" "fee" "fee_refund" "funding" "payment" "payment_method" "payout" "refund" "refund_failure" "transfer" "reversal" "transaction"
settlement_status
string
Enum: "settled" "unsettled"
start_date
string <date-time>
Deprecated
end_date
string <date-time>
Deprecated
created_at_start
string <date-time>
created_at_end
string <date-time>
updated_at_start
string <date-time>
updated_at_end
string <date-time>
settled_at_start
string <date-time>
settled_at_end
string <date-time>
string or string or string or string or string
Default: "updated_at"
sort_direction
string
Enum: "asc" "desc"
amount_min
integer
amount_max
integer

Responses

Request samples

Content type
application/json
{
  • "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

Content type
application/json
{ }

Payouts

Fetch a list of payouts

query Parameters
ending_before
string
starting_after
string
limit
number
string or string or string or string or string or string or string or string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fetch a payout by id

path Parameters
id
required
string
query Parameters
ledger_type
string
Enum: "operating" "funding"
currency
string
Enum: "USD" "CAD"
header Parameters
x-account-id
string

Required when fetching a payout associated with an account, exclude if fetching your own payout

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "payout",
  • "status": "created",
  • "payout_number": 0,
  • "transaction_count": 0,
  • "transaction_summary": [
    ],
  • "amount": 9007199254740991,
  • "net_amount": 9007199254740991,
  • "fee_amount": 9007199254740991,
  • "batch_fee": 9007199254740991,
  • "reject_fee": 9007199254740991,
  • "latest_payment_data": {
    },
  • "payment_data": [
    ],
  • "payment_attempt_count": 0,
  • "payment_reject_count": 0,
  • "owner_type": "account",
  • "owner_id": "string",
  • "ledger_type": "operating",
  • "currency": "USD",
  • "business_id": "string",
  • "batch_window": {
    },
  • "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"
}

Fetch a list of payouts for a business

query Parameters
ending_before
string

The id of the entity, use to sort in reverse order

starting_after
string

The id of the entity

limit
number
Default: 10

Max value is 50

header Parameters
x-business-id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Payment Method Intents

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
x-account-id
required
string
x-idempotency-key
string
Request Body schema: application/json
object or object
payment_method_types
Array of strings
Items Enum: "card" "bank"
object
validate
boolean
string or string

Responses

Request samples

Content type
application/json
{
  • "payment_method_data": {
    },
  • "payment_method_types": [
    ],
  • "user_fields": {
    },
  • "validate": true,
  • "bill_to": "merchant"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "client_secret": "string",
  • "entity": "payment_method_intent",
  • "status": "created",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "payment_method": {
    },
  • "validate": true,
  • "bill_to": "merchant",
  • "latest_validation_response": {
    },
  • "validation_attempts": [
    ],
  • "user_fields": {
    },
  • "cancellation_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

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
ending_before
string

The id of the entity, use to sort in reverse order

starting_after
string

The id of the entity

limit
number
Default: 10

Max value is 50

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

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
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "client_secret": "string",
  • "entity": "payment_method_intent",
  • "status": "created",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "payment_method": {
    },
  • "validate": true,
  • "bill_to": "merchant",
  • "latest_validation_response": {
    },
  • "validation_attempts": [
    ],
  • "user_fields": {
    },
  • "cancellation_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a payment method intent

path Parameters
id
required
string
Request Body schema: application/json
object
payment_method_types
Array of strings
Items Enum: "card" "bank"

Responses

Request samples

Content type
application/json
{
  • "user_fields": {
    },
  • "payment_method_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "client_secret": "string",
  • "entity": "payment_method_intent",
  • "status": "created",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "payment_method": {
    },
  • "validate": true,
  • "bill_to": "merchant",
  • "latest_validation_response": {
    },
  • "validation_attempts": [
    ],
  • "user_fields": {
    },
  • "cancellation_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Cancel a payment method intent

path Parameters
id
required
string
Request Body schema: application/json
cancellation_reason
string

Responses

Request samples

Content type
application/json
{
  • "cancellation_reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "client_secret": "string",
  • "entity": "payment_method_intent",
  • "status": "created",
  • "account_id": "string",
  • "payment_method_types": [
    ],
  • "payment_method": {
    },
  • "validate": true,
  • "bill_to": "merchant",
  • "latest_validation_response": {
    },
  • "validation_attempts": [
    ],
  • "user_fields": {
    },
  • "cancellation_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Fees

Fetch a list of fees.

Use this endpoint to retrieve a paginated list of fees for a merchant account. Fees represent various charges including processing fees, interchange fees, monthly minimums, and adhoc fees. You can filter by fee type, source, and date ranges to understand your cost structure and track fee-related transactions.

query Parameters
ending_before
string
starting_after
string
limit
number or null >= 0
fee_type
string
Enum: "APPLICATION" "BATCH" "CHARGEBACK" "INTERCHANGE" "PLATFORM" "TOKEN" "PROCESSING" "RETRIEVAL" "DDA_REJECT" "MONTHLY_MINIMUM" "PCI_NON_COMPLIANCE" "GATEWAY_FEE" "EARLY_CANCELLATION" "REGULATORY_PRODUCT" "VALIDATION_FEE" "LINKING_FEE" "REJECT_FEE" "REVERSAL_FEE" "UNKNOWN_BANK_ACTIVITY_ADJUSTMENT" "UNMATCHED_SETTLEMENT" "PARTNER_ADHOC"
source_id
string

Filter fees by source_id. Examples: A fee refund has a source_id of the original fee it is refunding. A processing fee has a source id of the payment.

header Parameters
x-account-id
required
string or null

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create an adhoc fee.

Create an adhoc fee for a merchant account. Fee refunds through this endpoint will be deprecated, please use the /fees/:id/refund endpoint instead.

header Parameters
x-account-id
required
string or null
Request Body schema: application/json

Body

amount
required
integer or null >= 0
currency
string
Enum: "USD" "CAD"
description
required
string <= 1000 characters
payment_id
string or null
reference_id
string <= 300 characters
object
is_refund
boolean

(Deprecated) By default, 'is_refund' is false, so the fee amount is charged to the merchant. When set to true, the amount is refunded to the merchant. Note: A 'payment_id' or 'fee_id' is required for all fee refunds.

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "currency": "USD",
  • "description": "string",
  • "payment_id": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "is_refund": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "fee",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "USD",
  • "fee_type": "APPLICATION",
  • "fee_sub_type": "auth",
  • "description": "string",
  • "from_owner_id": "string",
  • "from_owner_type": "account",
  • "to_owner_id": "string",
  • "to_owner_type": "account",
  • "source_type": "adjustment",
  • "source_id": "string",
  • "source_account_id": "string",
  • "amount": 0,
  • "amount_refunded": 0,
  • "auth_fee": 0,
  • "card_fee_bps": 0,
  • "ach_per_transaction_fee": 0,
  • "ach_fee_bps": 0,
  • "ach_bps_fee_max": 0,
  • "ach_service_type": "standard",
  • "card_type": "visa",
  • "settlement_id": "string",
  • "settlement_status": "settled",
  • "settled_at": "2019-08-24T14:15:22Z",
  • "monthly_fee_date": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "is_refund": true
}

Fetch a fee by id.

Fetch a fee by id for a merchant account

path Parameters
id
required
string or null
header Parameters
x-account-id
required
string or null

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "fee",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "USD",
  • "fee_type": "APPLICATION",
  • "fee_sub_type": "auth",
  • "description": "string",
  • "from_owner_id": "string",
  • "from_owner_type": "account",
  • "to_owner_id": "string",
  • "to_owner_type": "account",
  • "source_type": "adjustment",
  • "source_id": "string",
  • "source_account_id": "string",
  • "amount": 0,
  • "amount_refunded": 0,
  • "auth_fee": 0,
  • "card_fee_bps": 0,
  • "ach_per_transaction_fee": 0,
  • "ach_fee_bps": 0,
  • "ach_bps_fee_max": 0,
  • "ach_service_type": "standard",
  • "card_type": "visa",
  • "settlement_id": "string",
  • "settlement_status": "settled",
  • "settled_at": "2019-08-24T14:15:22Z",
  • "monthly_fee_date": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "is_refund": true
}

Refund an adhoc fee.

Partially or fully refund an adhoc fee up to the amount of the original fee. If partially refunding a fee, there is a limit of 10 refunds per fee.

path Parameters
id
required
string or null
Request Body schema: application/json

Body

amount
required
integer or null >= 0
description
required
string <= 1000 characters
reference_id
string <= 300 characters
object

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "description": "string",
  • "reference_id": "string",
  • "user_fields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "fee",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "USD",
  • "fee_type": "APPLICATION",
  • "fee_sub_type": "auth",
  • "description": "string",
  • "from_owner_id": "string",
  • "from_owner_type": "account",
  • "to_owner_id": "string",
  • "to_owner_type": "account",
  • "source_type": "adjustment",
  • "source_id": "string",
  • "source_account_id": "string",
  • "amount": 0,
  • "amount_refunded": 0,
  • "auth_fee": 0,
  • "card_fee_bps": 0,
  • "ach_per_transaction_fee": 0,
  • "ach_fee_bps": 0,
  • "ach_bps_fee_max": 0,
  • "ach_service_type": "standard",
  • "card_type": "visa",
  • "settlement_id": "string",
  • "settlement_status": "settled",
  • "settled_at": "2019-08-24T14:15:22Z",
  • "monthly_fee_date": "string",
  • "reference_id": "string",
  • "user_fields": {
    },
  • "is_refund": true
}

Ledger Account

Fetch ledger account

Fetch a ledger account by owner_id

path Parameters
owner_id
required
string
query Parameters
ledger_type
string
Enum: "operating" "funding"
currency
string
Enum: "USD" "CAD"

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "ledger_account",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner_type": "account",
  • "owner_id": "string",
  • "ledger_type": "operating",
  • "currency": "USD",
  • "partitions": 0,
  • "cross_river_account_number": "string",
  • "bank_identifier": "string",
  • "bank_identifier_type": "crossriver",
  • "payouts_count": 0,
  • "meta_data": {
    }
}

Update ledger account

Update the number of partitions for a ledger account

path Parameters
id
required
string
Request Body schema: application/json

Body

partitions
required
integer [ 1 .. 50 ]

Responses

Request samples

Content type
application/json
{
  • "partitions": 1
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "ledger_account",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner_type": "account",
  • "owner_id": "string",
  • "ledger_type": "operating",
  • "currency": "USD",
  • "partitions": 0,
  • "cross_river_account_number": "string",
  • "bank_identifier": "string",
  • "bank_identifier_type": "crossriver",
  • "payouts_count": 0,
  • "meta_data": {
    }
}

Payments

Fetch a payment by ID

path Parameters
id
required
string
header Parameters
x-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "entity": "payment",
  • "status": "processing",
  • "currency": "USD",
  • "billing_details": {
    },
  • "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": {
    },
  • "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": {
    },
  • "gateway_response": {
    },
  • "payment_intent_id": "string",
  • "payment_method_id": "string",
  • "payment_method": {
    },
  • "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": {
    },
  • "description": "string",
  • "settlement_status": "settled",
  • "settled_at": "string"
}

Surcharge

Calculate surcharge fee for a payment

header Parameters
x-account-id
required
string
Request Body schema: application/json
payment_method_id
required
string
postal_code
string <= 10 characters
amount
required
integer [ 0 .. 9007199254740991 ]
percent
required
number [ 0 .. 3 ]

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "postal_code": "string",
  • "amount": 9007199254740991,
  • "percent": 3
}

Response samples

Content type
application/json
{
  • "card_type": "Credit",
  • "restricted": "Y",
  • "fee_amount": 9007199254740991
}

Unmatched Settlements

Fetch a list of unmatched settlements.

Fetch unmatched payments, refunds, and associated unmatched record data.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}