Skip to main content
Create a payment transaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.

Required string length: 1 - 257
Pattern: ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
type
enum<string>
required

What to create.

Available options:
payment
amount
object
required

An amount of money. Decimal values are refused, not rounded.

order
object
required

The caller's order. Not unique: a reusable link puts it on every payment transaction.

customer_details
object
required

The person paying, as a plain object. On the response, customer_details is a link to these details.

statement_descriptor
string
required

Becomes alphanumeric on the way to the bank. On a payment transaction through a virtual account, the customer's statement shows Quidkey's reconciliation reference instead.

Required string length: 1 - 18
authorization
object
required

How the customer authorizes the payment transaction, and what that needs.

is_test
boolean
default:false
conditionally required

Creates a test payment transaction, which any merchant can do before going live.

rewards
object

Points shown to the customer.

webhook_endpoints
object[]

Not for a partner, whose payment transactions report to the partner's endpoint. Answers UNKNOWN_WEBHOOK_ENDPOINT if one doesn't exist, isn't active, or doesn't take this payment transaction's environment.

Maximum array length: 10
simulation
object

Chooses how a test payment transaction ends. USD only. It isn't read back.

Response

The transaction, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required