Create a payment

Collect a payment from an individual user

Authorization

AuthorizationBearer <token>

Merchant JWT bearer token

In: header

Scope: payments.create

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotencyKey*IdempotencyKey

This can be any unique identifier. It is required to protect against accidental duplicate calls, which may cause unintended consequences.

amountMoney*

The amount of money to capture

paymentToken*PaymentToken

The id/token for the source of the payment. This can be a generated card nonce or the id to a saved customers card.

verificationToken?VerificationToken

The verification token encapsulates customer device information and 3-D Secure challenge results to indicate that the buyer identity has been verified.

shippingAddress?

The shipping address for the order

billingAddress?

The customer's billing address

isDynamicPricingEnabled?boolean

Determines whether a payment was made with dynamic pricing

userId?CustomerId

Deprecated

deprecated in favour of customerId field

customerId?CustomerId

Deprecated

deprecated in favour of customerId field

lineItemParams?array<>

autocomplete?PaymentAutoComplete

If set to true, this payment will be completed (captured) automatically. If set to false, this payment is held in an approved (authorized) state until either explicitly completed (captured) or canceled (voided)

expirationDate?PaymentExpirationDate

The date and time at which the payment will expire if autocomplete is set to false. If undefined the payment will attempt complete after 7 days.

statementDescriptionIdentifier?StatementDescription

The statement description sent to the card networks.

Note: Not all gateways support this and the actual statement description varies and is likely to be truncated and appended with additional information.

description?PaymentDescription

A description of the payment to be shown in web interfaces.

referenceId?ReferenceId

A unique identifier set by a developer to help reconcile this object with any internal systems

metaData?

A Key-value object to hold additional data

airlineData?

Additional data required for airlines to make payments

Response Body

`application/json`

curl -X POST "https://example.com/payments" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string",    "amountMoney": {      "amount": 100,      "currency": "AED"    },    "paymentToken": "string"  }'

{
  "merchantId": "string",
  "id": "string",
  "status": "APPROVED",
  "isDynamicPricingEnabled": false,
  "totalMoney": {
    "amount": 100,
    "currency": "AED"
  },
  "amountMoney": {
    "amount": 100,
    "currency": "AED"
  },
  "approvedMoney": {
    "amount": 100,
    "currency": "AED"
  },
  "refundedMoney": {
    "amount": 100,
    "currency": "AED"
  },
  "capturedMoney": {
    "amount": 100,
    "currency": "AED"
  },
  "refundIds": [
    "string"
  ],
  "expirationDate": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "onBehalfOf": "string",
  "lineItems": [
    {
      "item": {
        "metaData": {
          "property1": "string",
          "property2": "string"
        },
        "referenceId": "string",
        "description": "string",
        "imageUrls": [
          "https://www.randomurl.com"
        ],
        "attributes": {
          "size": "xs",
          "color": "blue"
        },
        "sku": "string",
        "amountMoney": {
          "amount": 100,
          "currency": "AED"
        },
        "name": "string",
        "id": "string"
      },
      "quantity": 0,
      "subtotalMoney": {
        "amount": 100,
        "currency": "AED"
      },
      "totalMoney": {
        "amount": 100,
        "currency": "AED"
      }
    }
  ],
  "groupPaymentId": "string",
  "multiCardId": "string",
  "cardDetails": {
    "card": {
      "id": "string",
      "cardBrand": "string",
      "country": "AF",
      "mask": "string",
      "last4": "string",
      "expMonth": 0,
      "expYear": 0,
      "cardholderName": "string",
      "fingerprint": "string",
      "bin": "string"
    },
    "cvvStatus": "CVV_ACCEPTED",
    "avsStatus": "AVS_ACCEPTED",
    "authResultCode": "string",
    "verificationResults": "SUCCESS",
    "threeDSecure": {
      "eci": "string",
      "xid": "string",
      "cavv": "string",
      "threeDSVersion": "string",
      "directoryResponse": "string",
      "authenticationResponse": "string",
      "transStatusReason": "string",
      "cardHolderInfo": "string",
      "threeDSTransactionId": "string"
    }
  },
  "shippingAddress": {
    "addressLines": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string"
    },
    "name": "string",
    "city": "string",
    "country": "AF",
    "postalCode": "string",
    "organization": "string",
    "sublocality": "string"
  },
  "billingAddress": {
    "addressLines": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string"
    },
    "name": "string",
    "city": "string",
    "country": "AF",
    "postalCode": "string",
    "organization": "string",
    "sublocality": "string"
  },
  "statementDescriptionIdentifier": "string",
  "description": "string",
  "referenceId": "string",
  "metaData": {
    "property1": "string",
    "property2": "string"
  },
  "autocomplete": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "gatewayVersion": 0.1,
  "gatewayId": "string",
  "gatewayName": "square",
  "gatewayPaymentId": "string",
  "airlineData": {
    "market": "string",
    "iataCode": "st",
    "countryCode": "string",
    "address": "string",
    "tickets": [
      {
        "issueDate": "2019-08-24T14:15:22Z",
        "ticketNumber": "string",
        "passenger": {
          "code": "string",
          "countryCode": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string",
          "ageCategory": "BABY"
        },
        "legs": [
          {
            "flightNumber": "string",
            "departureAirportCode": "string",
            "arrivalAirportCode": "string",
            "serviceClassCode": "st",
            "carrierCode": "st",
            "departureDate": "2019-08-24T14:15:22Z",
            "departureTime": "string",
            "arrivalDate": "2019-08-24T14:15:22Z",
            "arrivalTime": "string",
            "couponNumber": "string",
            "fareBasisCode": "string"
          }
        ]
      }
    ]
  },
  "internalReferenceId": "string"
}

{
  "http_status_code": 100,
  "moreInfo": "https://www.randomurl.com",
  "name": "string",
  "detail": "string",
  "instance": "/pets/dogs/123",
  "property1": null,
  "property2": null
}

Create a payment

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`