Sign in

v1

latestOpenAPI 3.0.12026-07-14134373.9 KB
Payment Service

Process a payment transaction

Accepts payment details and processes the transaction.

post/payment/processPayment

Request body

storedPaymentMethodIdstring

Identifier of a previously stored payment method, such as a credit card or bank account. When provided, the payment is processed using the stored payment method.

subscriptionIdstring

Unique subscription identifier associated with the customer and payment method. Provide this field to use an existing subscription. If storePaymentMethod is true and this field is not provided, a new subscriptionId is created during payment processing.

Example request

{
  "customer": {
    "identities": [
      {
        "identityTypeId": 1,
        "value": "SSN Number, Passport Id, Driver's license, etc.",
        "countryCode": "US",
        "region": "CA"
      }
    ]
  }
}

Response

Payment request processed successfully. The payment may be approved or declined. Check the response status for the transaction outcome.

orderIdinteger

Unique identifier of the payment transaction.

paymentTimestampstring date-time

Date and time when the payment transaction was processed.

amountnumber

Base payment amount for the transaction, excluding fees.

feeAmountnumber

Fee amount applied to the transaction.

totalAmountnumber

Total amount charged for the transaction, including fees.

subscriptionIdstring

Unique subscription identifier associated with the customer. Returned when an existing subscription is used, or when a new subscriptionId is created because storePaymentMethod is true and subscriptionId was not provided in the request.

storedPaymentMethodIdstring

Identifier of the stored payment method. Returned when storePaymentMethod is true and the payment method is successfully stored.

status'Success' | 'Refused' | 'Failed' | 'Cancelled' | 'PendingPayment' | 'PendingSettle' | 'Review'

Status of the payment transaction.

errorMessagestring

Error message returned when the transaction fails.

errorDetailsstring

Detailed error information for troubleshooting purposes.

storePaymentMethodStatus'success' | 'failed'

Status of storing the payment method. Returned only when storePaymentMethod is true in the request.

retryboolean

Indicates whether the payment attempt can be retried.

Example response

{
  "status": "Success",
  "storePaymentMethodStatus": "success",
  "retry": true
}
All 13 operations