Payments APIPayment

Initiate Payment

Processes a payment transaction directly.

Request

Payment initiation request
sessionIdstringRequired
Session ID from checkout session creation
paymentMethodIdenumRequired
Payment method identifier
paymentDetailsobjectRequired
Payment method specific details
attributesmap from strings to stringsOptional

Additional transaction attributes as key-value pairs

signaturestringOptional
HMAC signature for hosted checkout validation

Response

Payment processed with result
statusstring
Current transaction status
transactionIdstring
Unique transaction identifier
messagestring
Status message describing the transaction state
authStateobject
Authentication state union containing all possible transaction states
merchantReferencestring
Merchant reference from the original session
sessionIdstringformat: "uuid"
Session ID associated with the transaction
identifiersmap from strings to strings
Additional identifiers related to the transaction
paymentAttributesmap from strings to strings

Payment-specific attributes and metadata

paymentMethodIdstring
Payment method identifier
processorNamestring
Payment processor name
processorReferencestring
Payment processor reference
financialTransactionReferencestring
Financial transaction reference from the processor
currentAttemptIdstring
Current attempt identifier
batchPayoutIdstring
Batch payout identifier, if the transaction is part of a batch payout

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error