Sign in

v1

latestOpenAPI 3.0.12026-08-062379143.9 KB
Payments

Make payment

Make a payment using credit card, cash, cheque, profile, token, Apple Pay, or Google Pay. Each payment type has its own json definition passed in the body. For all payments you have the standard Billing, Shipping, Comments, etc. fields that are optional. Only the amount is required along with the payment data for card, cash, cheque, profile, and token. You must change the payment_method for each payment type. Credit Card - "card", Payment Profile - "payment_profile", Single Use Token - "token", Cash - "cash", Cheque - "cheque", Apple Pay - "apple_pay", Google Pay - "google_pay", 3D Secure token - "3d_secure_token".

post/payments

Request body

order_numberstring

A unique order number.

amountnumber double required

A decimal value in dollars. Uses up to two decimal places. Max value is account specific. Default max value is 1000.

payment_method'card' | 'token' | 'payment_profile' | 'cash' | 'cheque' | 'apple_pay' | 'google_pay' | '3d_secure_token' | 'processor_token' required

The desired method of payment.

ship_same_as_ordboolean

If true, the provided Billing Address information will also be used as the Shipping Address information.

device_channel'02' | '03'

Type of channel used to initiate the transaction. 02 = Browser, 03 = 3DS Requestor.

languagestring

characters

customer_ipstring

IP Address of the api consumer. Required if calculating risk score.

term_urlstring

Callback URL used with 3D Secure payment processing.

commentsstring

alphanumeric

recurring_paymentboolean

A recurring transaction is a transaction where a cardholder had provided permission to a merchant to periodically charge his/her account number for recurring goods or services. The recurring payment indicator may be set for credit card based pre-auth, capture and purchase transactions.

Response

Payment response containing the payment details as well as if the payment was approved or declined.

idstring

transaction Id

authorizing_merchant_idinteger

The id of the merchant that authorized the transaction.

approvedstring

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_idinteger

Payment response code

messagestring

Message containing information about the transactions status

auth_codestring

Auth Code

createdstring date-time

Time stamp of when the transaction occurred

order_numberstring

Order number

type'P' | 'R' | 'VP' | 'VR' | 'PA' | 'PAC'

Payment transaction type

risk_scorenumber double

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amountnumber double

A decimal value in dollars. Uses up to two decimal places.

payment_method'card' | 'token' | 'payment_profile' | 'cash' | 'cheque' | 'apple_pay' | 'google_pay'

Payment method

merchant_datastring

Returned only for 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contentsstring

Returned only for 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the 3D Secure processing page.