Checkout

Get invoice from checkout token

get

Retrieves the invoice associated with the checkout token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Responses

200

OK

application/json

Invoice response

created_atstringOptional

currencystringOptional

customer_idstringOptional

due_datestringOptional

idstringOptional

invoice_numberstringOptional

statusstringOptional

sub_totalnumberOptional

totalnumberOptional

400

Bad Request

application/json

404

Not Found

application/json

get

/checkout/v1/invoice

HTTPcURLJavaScriptPython

GET /checkout/v1/invoice HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "created_at": "text",
  "currency": "text",
  "customer_id": "text",
  "due_date": "text",
  "id": "text",
  "invoice_number": "text",
  "status": "text",
  "sub_total": 1,
  "total": 1
}

Get invoice PDF link from checkout token

get

Retrieves the PDF download link for the invoice associated with the checkout token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Responses

200

OK

application/json

PDF link response

urlstringOptional

400

Bad Request

application/json

404

Not Found

application/json

get

/checkout/v1/invoice/pdf-link

HTTPcURLJavaScriptPython

GET /checkout/v1/invoice/pdf-link HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "url": "text"
}

Get payment methods from checkout token

get

Retrieves all payment methods for the customer associated with the checkout token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Responses

200

OK

application/json

List of payment methods response

400

Bad Request

application/json

get

/checkout/v1/payment-methods

HTTPcURLJavaScriptPython

GET /checkout/v1/payment-methods HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "brand": "visa",
      "created_at": "text",
      "default": true,
      "exp_month": "01",
      "exp_year": "2025",
      "id": "text",
      "last4": "text",
      "type": "card"
    }
  ]
}

Register CVV for a card payment from checkout token

post

Register an encrypted CVV token for a specific card. Uses customer_id and invoice_id from checkout token.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Path parameters

card_idstringRequired

Card ID

Body

application/json

CVV registration information

cvv_secretstringOptional

providerstring · enumOptionalPossible values:

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/checkout/v1/payment-methods/{card_id}/cvv

HTTPcURLJavaScriptPython

POST /checkout/v1/payment-methods/{card_id}/cvv HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "cvv_secret": "text",
  "provider": "evervault"
}

{
  "success": true
}

Calculate card payment fees

post

Calculate payment fees for a specific card payment method using checkout token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Path parameters

card_idstringRequired

Card ID

Body

application/json

Request body for calculating card payment fees

amountstringOptionalExample: 100.00

currencystring · enumOptionalExample: USDPossible values:

Responses

200

OK

application/json

Response containing calculated payment fees for card payments

fee_percentage_for_customerstringOptionalExample: 2.50

fee_percentage_for_partnerstringOptionalExample: 1.50

fixed_fee_amount_customerstringOptionalExample: 0.50

fixed_fee_amount_partnerstringOptionalExample: 0.25

relative_fee_amount_customerstringOptionalExample: 2.50

relative_fee_amount_partnerstringOptionalExample: 1.50

400

Bad Request

application/json

404

Not Found

application/json

post

/checkout/v1/payment-methods/{card_id}/fees

HTTPcURLJavaScriptPython

POST /checkout/v1/payment-methods/{card_id}/fees HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "amount": "100.00",
  "currency": "USD"
}

{
  "fee_percentage_for_customer": "2.50",
  "fee_percentage_for_partner": "1.50",
  "fixed_fee_amount_customer": "0.50",
  "fixed_fee_amount_partner": "0.25",
  "relative_fee_amount_customer": "2.50",
  "relative_fee_amount_partner": "1.50"
}

Create a bank account payment method from checkout token

post

Creates a new bank account payment method for the customer associated with the checkout token. Only one of USAccountData or CAAccountData must be sent, matching AccountDataType.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Body

application/json

Create bank account payment method request body. Only one of USAccountData or CAAccountData must be sent, matching AccountDataType.

account_data_typestring · enumOptionalPossible values:

custom_namestringOptional

institution_namestringOptional

receiver_namestringOptional

subtypestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

Responses

200

OK

application/json

Create bank account response

idstringOptional

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/checkout/v1/payment-methods/bank

HTTPcURLJavaScriptPython

POST /checkout/v1/payment-methods/bank HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "account_data_type": "us",
  "ca_account_data": {
    "account_number": "text",
    "institution_code": "text",
    "transit_number": "text"
  },
  "custom_name": "text",
  "institution_name": "text",
  "receiver_name": "text",
  "subtype": "checkings",
  "type": "depository",
  "us_account_data": {
    "account_number": "text",
    "routing_number": "text"
  }
}

{
  "id": "text"
}

Create a card payment method from checkout token

post

Creates a new card payment method for the customer associated with the checkout token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Body

application/json

Create card payment method request body

card_provider_tokenstringOptional

custom_namestringOptional

providerstring · enumOptionalPossible values:

Responses

200

OK

application/json

Create card response

idstringOptional

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/checkout/v1/payment-methods/card

HTTPcURLJavaScriptPython

POST /checkout/v1/payment-methods/card HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "address": {
    "city": "text",
    "country": "text",
    "country_code": "text",
    "postal_code": "text",
    "state": "text",
    "state_code": "text",
    "street_address": "text",
    "subpremise": "text"
  },
  "card_provider_token": "text",
  "custom_name": "text",
  "provider": "evervault"
}

{
  "id": "text"
}

Create a payment from checkout token

post

Creates a payment for the invoice associated with the checkout token. Customer ID and invoice ID are extracted from the token.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for checkout endpoints. Pass the token as "Bearer {token}" in the Authorization header.

Body

application/json

Create payment request body

amountstringOptionalExample: 100.00

idempotency_keystringOptionalExample: 00000000-0000-0000-0000-000000000000

payment_datestringOptionalExample: 2025-01-01T00:00:000Z

payment_methodstring · enumOptionalPossible values:

payment_method_idstringOptionalExample: 00000000-0000-0000-0000-000000000000

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/checkout/v1/payments

HTTPcURLJavaScriptPython

POST /checkout/v1/payments HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "amount": "100.00",
  "idempotency_key": "00000000-0000-0000-0000-000000000000",
  "payment_date": "2025-01-01T00:00:000Z",
  "payment_method": "card",
  "payment_method_id": "00000000-0000-0000-0000-000000000000"
}

{
  "message": "Payment is being processed!",
  "status": "processing"
}