Skip to content

Submit card payment

POST
/v1/sources/{sourceId}/payments/card

Submit a card payment that is detached from a receipt, e.g. received through another source.

sourceId
string
Example
src-33MxMq4MYpTSMw4xgkW9mGSe9p0

Source ID

CardPaymentRequest
object
header
required
PaymentHeader
object
storeId

ID of the store that captured the payment

string
brandId

ID of the brand that captured the payment

string
created
required

Timestamp of when the payment was created.

string format: date-time
Example
2025-08-25T08:57:37+00:00
receiptId

Receipt ID internal to the store

string
Example
50450120058
orderId

Order ID internal to the store.

string
Example
345-499
purchaseOrderId

Purchase Order ID internal to the customer.

string
Example
R331883
payment
required
CardPayment
object
paymentType
required
string
default: card
Allowed values: card
paid
required
Money

Monetary amount in a specific currency.

object
amount
required

Amount of money, represented as a number with optional fractional part.

number format: decimal
Example
19.99
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
paymentTypeLabel

Type of card that was used. Informational element, do not assume any specific syntax or localization.

string
Example
DEBIT MASTERCARD
paymentAccountReference

Payment Account Reference (PAR) is 29 characters long. The first four positions of the PAR contain the BIN Controller Identifier. See: https://www.emvco.com/registered-ids

string
>= 29 characters <= 29 characters
Example
12345678912345678912345678912
transactionId

Unique identifier generated by the bank, gateway, or store system. Format may be numeric, alphanumeric, or UUID depending on implementation. Not standardized across networks. Used for internal tracking within the originating system and may not be valid outside that system.

string
retrievalReferenceNumber

Retrieval Reference Number (RRN). Unique transaction identifier from the payment network (ISO 8583 DE37). Typically a 12-digit string (UPI, card networks); may vary by system. Generated by acquirer/network, not store. Treat as string and preserve any leading zeros.

string
lastFour

Last four digits of the payment card that was used

string
>= 4 characters <= 4 characters
Example
4931
systemTraceAuditNumber

System Trace Audit Number (STAN), 6 digits, sometimes printed as REF on the receipt.

string
<= 6 characters
Example
123456
terminalId

ID of the terminal used to capture the payment.

string
approvalCode

Approval Code, sometimes printed as AUTH on the receipt.

string
terminalSlip

Verbatim representation of the terminal slip, typically output directly from the terminal itself.

string
Example
Term: 19400085-970006
2025-01-01 12:06
DEBIT MASTERCARD
Contactless
************3204-0
AID: A0000000001010
ATC: 00256
AED:230801
TVR: 0000008001
Sted: 1111112
Ref.: 430639 010124 KC1
Resp.: 00
Periode: 169
KB
DKK 14,00
GODKENDT

Receipt received

Bad or malformed request

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri

Unauthorized

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri

Forbidden

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri