Transactions
Initiate Transaction
Initiate a new transaction (sale or auth).
Merchant API keys can call this endpoint for their own account.
Partner API keys can also call this endpoint, but they must include merchant_id
for a merchant linked to that partner.
Partner API keys can also capture, refund and void transactions for linked merchants under the same merchant_id rules.
Duplicate requests reusing an active reference are rejected with HTTP 409. See the duplicate protection guide.
Initiate Transaction › Request Body
amountTransaction amount in major units, for example 12.50 for EUR 12.50. Minimum 1.00. Responses and webhooks report amounts in minor units.
currencyTransaction currency (3-letter ISO code).
transaction_typeTransaction type.
walletDigital wallet payment. Mutually exclusive with card and vault_token.
vault_tokenVault token of a stored card, returned in the payment_instrument object of a previous transaction response. Tokens are scoped to the merchant that stored the card. When provided, card number and expiry are not required. Only CVV is still needed.
Card details object. Required unless vault_token or wallet is provided.
referenceMerchant reference for this transaction.
merchant_idRequired for partner API keys. Omit for merchant API keys.
success_urlURL to redirect to on successful payment (reserved for future use).
error_urlURL to redirect to on failed payment (reserved for future use).
customerCustomer details object.
card_verification_dataLinks a completed 3DS verification to this transaction. Pass the public_id returned from POST /api/v1/3ds/verify. The API retrieves stored CAVV, ECI and DS Transaction ID automatically. The verification must have ended in full_auth, attempt or unavailable; a failed or unfinished verification is refused with HTTP 422.
browser_dataBrowser fingerprint for provider-led 3DS (same shape as POST /api/v1/3ds/verify). Recommended for Paycent to reduce unnecessary 3DS challenges.
Initiate Transaction › Responses
successmessagecodeCapture Transaction
Capture a previously authorized transaction.
Send an Idempotency-Key header to retry safely. A repeat with the same
key returns the original response without capturing again. The
API conventions page has the full contract.
This endpoint is intended for merchant API keys managing their own transactions. Do not expose this as a partner-facing operation in external integrations.
path Parameters
transaction_idThe ID of the transaction.
Headers
Idempotency-KeyOptional key that makes retrying this request safe. A repeat with the same key within 24 hours replays the original response instead of executing again. See API conventions.
Capture Transaction › Request Body optional
amountAmount to capture in major units. Omit to capture the full authorized amount.
Capture Transaction › Responses
successmessagecodeRefund Transaction
Refund a previously captured transaction.
Send an Idempotency-Key header to retry safely. A repeat with the same
key returns the original response without refunding again. The
API conventions page has the full contract.
This endpoint is intended for merchant API keys managing their own transactions. Do not expose this as a partner-facing operation in external integrations.
path Parameters
transaction_idThe ID of the transaction.
Headers
Idempotency-KeyOptional key that makes retrying this request safe. A repeat with the same key within 24 hours replays the original response instead of executing again. See API conventions.
Refund Transaction › Request Body optional
amountAmount to refund in major units. Omit to refund the full amount.
reasonReason for refund.
Refund Transaction › Responses
successmessagecodeTransaction Status
Get the status of a transaction.
Merchant API keys can check their own transactions. Partner API keys can check, capture, refund and void transactions belonging to linked merchants they are allowed to access. Ownership is enforced by the request layer.
path Parameters
transaction_idThe ID of the transaction.
Transaction Status › Responses
successmessagecodeVoid Transaction
Void a previously initiated auth transaction.
Send an Idempotency-Key header to retry safely. A repeat with the same
key returns the original response without voiding again. The
API conventions page has the full contract.
This endpoint is intended for merchant API keys managing their own transactions. Do not expose this as a partner-facing operation in external integrations.
path Parameters
transaction_idThe ID of the transaction.
Headers
Idempotency-KeyOptional key that makes retrying this request safe. A repeat with the same key within 24 hours replays the original response instead of executing again. See API conventions.
Void Transaction › Request Body optional
amountAmount to void in major units. Omit to void the full amount.
reasonReason for void.
Void Transaction › Responses
successmessagecode