Payment Context

Request a Payment Context #

Send a Payment Context request. Successful Payment Context requests will always return a 201 response.

Authorizations

bearer

#

HTTP: bearer #

HTTP Authorization Scheme: bearer

Bearer format: JWT

header Parameters #

Authorizationrequired	stringBearer token (API Key or OAuth2 Access Token).
Cko-Idempotency-Key	stringAn optional idempotency key for safely retrying payment requests.

Request Body schema: application/json #

Request body for creating a Payment Context.

source required	objectThe source of the payment.
currency required	string = 3 characters The three-letter ISO currency code.
amount required	number >= 0 The Payment Context Payment amount. The amount must be provided in the minor currency unit.
payment_type	string Default: “Regular” Enum:”Regular””Recurring”The payment type. “Recurring” must be specified if the payment is paid in multiple installments.
capture	boolean Default: trueWhether to capture the later payment (if applicable).
customer	objectThe customer details.
shipping	objectThe shipping details.
processing	objectUse the processing object to influence or override the data sent during card processing.
processing_channel_id	string^(pc)_(\w{26})$The processing channel to be used for the payment.
reference	string <= 50 characters A reference you can later use to identify this Payment Context, such as an order number. Can only be alphanumeric and must be unique for Benefit. For Amex, the string limit is 30 characters.
description	string <= 100 characters A description of the Payment Context.
success_url	string <= 1024 characters Overrides the default success redirect URL configured on your account.
failure_url	string <= 1024 characters Overrides the default failure redirect URL configured on your account.
items	Array of objectsThe order line items. Required for Klarna payments.
metadata	objectA set of key-value pairs to store additional information about a transaction. Up to 20 fields, 255 chars each. Only string, number, boolean allowed.

Responses #

201 Payment Context Created.

Response Schema: application/json #

id required	stringPayment Context’s unique identifier.
partner_metadata required	objectProcessing object
processed_on required	string <date-time> The date and time when the payment context was processed in UTC.
_linksrequired	objectThe links related to the payment.
amount required	numberThe payment amount.
status required	stringThe status of the payment context.
response_code required	stringThe gateway response code.
response_summary required	stringThe gateway response summary.
available_payment_types	Array of objectsContains information about the available payment type returned by the partner for this purchase.
unavailable_payment_types	Array of objectsContains information about the unavailable payment type returned by the partner for this purchase.

401 Unauthorized

422 Invalid data was sent.

Response Schema: application/json #

request_id required	stringThe unique request identifier.
error_type required	stringThe error type.
error_codes required	Array of stringsThe error codes.

429 Too many requests or duplicate request detected.

Response Schema: application/json #

request_id required	stringThe unique request identifier.
error_type required	stringThe error type.
error_codes required	Array of stringsThe error codes.

502 Bad gateway

Get Payment Context details #

Returns all the Payment Context details.

Authorizations

bearer

#

HTTP: bearer #

HTTP Authorization Scheme: bearer

Bearer format: JWT

path Parameters #

id required

string = 30 characters ^(pct)_(\w{26})$Payment Context’s unique identifier.

header Parameters #

Authorization required

string

Responses #

200 Payment Context retrieved successfully.

Response Schema: application/json #

payment_request required	objectThe payment request details.
partner_metadata required	objectProcessing object
status required	string Default: “Created” Enum:”Created””Approved”The status of the payment context.

401 Unauthorized

404 Payment Context not found.

Response Schema: application/json #

request_id required	stringThe unique request identifier.
error_type required	stringThe error type.
error_codes required	Array of stringsThe error codes.