Sign in
Checkout

Create a payment from checkout token

Changed on

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

post/checkout/payments

Request

  • Base URL: https://public-api.alternativepayments.io
  • URL: https://public-api.alternativepayments.io/checkout/payments
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Used when idempotency_key is not set in the body. Non-UUID values are hashed to a UUID.

Request body

amountstring
idempotency_keystring uuid
payment_datestring
payment_method'card' | 'standard_ach'
payment_method_idstring

Example request

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

Response

Created

messagestring
statusstring

Example response

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

Changes