v1

latestOpenAPI 3.0.12026-07-14134373.9 KB
Order Service

Get order receipt

Retrieves receipt details for a completed order using the orderId.

post/order/receipt/{orderId}

Path parameters

orderIdinteger required

Unique identifier of the order.

Response

Order receipt retrieved successfully.

orderIdinteger

Unique identifier of the order.

orderDatestring date-time

Date and time when the order was created.

paymentAmountnumber

Total paid amount for the order.

partnerNamestring

Name of the partner or agency receiving payment.

shopperStatementstring

Statement text shown to the customer for this payment.

reviewboolean

Indicates whether the order requires manual review.

disclaimersstring[]

List of disclaimer messages shown on the receipt.

emailSubjectstring

Subject line used when the receipt is sent by email.

Example response

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