creditcards

Post
/api/pay/v1/creditcards

Using the credit cards resource to accept ECOM and MOTO payments. For ECOM, the response will be an html form (acsform) that needs to be auto-submitted for the transaction to go through 3Ds checks. MOTO payments will be processed immediately.

Request Body

  • payment_intent (string, required): The payment intent token.
  • paymentToken (string, required): The tokenised card details.
  • type (integer, required): For ECOM, value is 1. For MOTO, value is 2.
  • customer_email (string, required): The email address of the customer making the payment.
  • customer_name (string, required): The name of the customer making the payment.
  • transaction_unique (string, required): A unique identifier for the transaction.
  • device_timezone (string, required): Device timezone value which can be fetched using javascript and assigned to the respective hosted input field.
  • device_capabilities (string, required): Device capabilities which can be fetched using javascript and assigned to the respective hosted input field.
  • device_accept_language (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
  • device_screen_resolution (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
  • remote_address (string, required): Remote address which can be fetched using javascript and assigned to the respective hosted input field.
  • merchant_data (json, optional): Additional custom data related to the merchant or customer.

Response

ECOM: acsform (string): an html form to be submitted for 3DS screening. See here how to handle the 3DS form.

MOTO: url (string): The return_url entered in the intent with query parameters of the transaction result. 

Security
HTTP
Type bearer
Header parameters
Authorization
string
ExampleBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c
Body parameters
object
Example{ "payment_intent": "{{payment_intent}}", "paymentToken": "{{paymentToken}}", "customer_email": "{{$randomEmail}}", "customer_name": "{{$randomFullName}}", "transaction_unique": "{{transaction_unique}}", "type": 2, "merchant_data": "{\"order_id\": \"cc-12345678\"}", "customer_address": "23 Rogerham Mansions 4578 Ermine Street Borehamwood", "customer_postcode": "WD54 8TH" }
Responses
200

Successful response