PurchaseOrderList

List of purchase orders for the current customer.

purchaseOrders object[]

Array [

idstringrequired

Purchase order identifier.

amountinteger<int64>required

Total purchase order amount in currency minor units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

recipient objectrequired

Payee presented to the customer for an external purchase order.

externalIdstring

Recipient external identifier in the upstream merchant or provider system.

fullNamestring

Recipient display name shown to the customer.

typestring

Recipient classification for display.

Possible values: [CUSTOMER, MERCHANT]

merchantRefNumMerchantReferenceNumber (string)required

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Possible values: <= 255 characters

Example: 4bc2deb3-9766-4598-a08e-a98b60615936

paymentFunding object

Payment funding distribution information

discounts object[]

Customer discounts attached to the transaction.

Array [

amountinteger<int64>required

Discount amount in minor currency units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

typestringrequired

Discount source type.

Possible values: [POINTS, VOUCHER]

redemption object

Identifies a chosen discount option for redemption APIs (for example purchase-order discountDetails or transfer preview discounts). The presence of a redemption resource indicates whether the downstream business domain is responsible for debiting the customer's loyalty rewards. If redemption is not provided, the discount is applied as a fiat adjustment, and no loyalty rewards are debited.

referencestringrequired

Stable reference for this discount tier or voucher (for example points amount as a string, voucher code, or 0 for no discount).

displayNamestring

Customer-facing label for the discount option in UI copy.

]

wallet objectrequired

Wallet funding part when initiating payment with discount options.

amountinteger<int64>required

Funding amount in minor units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

fees object[]

Customer fees attached to the purchase order.

Array [

amountinteger<int64>required

Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

Possible values: >= 0

Default value: 0

Example: 1000

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

paymentReasonFeePaymentReason (string)required

Fee payment reason.

SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
ATM_FEE - Fee for ATM service, when using prepaid cards.
FX_FEE - Fee applied, when payment requires currency exchange.
VAT_FEE - Consumer VAT fee (when applicable)
OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction

Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, VAT_FEE, WITHDRAWAL_FEE]

Default value: OTHER_FEE

]

creationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

expirationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

statusPayment Status (string)required

The payment status:

PREVIEW - Payment preview.
PENDING - Payment transaction is created and further action is required by the customer.
PROCESSING - Payment is scheduled for processing by the payment provider.
COMPLETED - Payment is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
FAILED - Payment has failed. Check STATUS_REASON property for details.
CANCELLED - Payment have been cancelled
REFUNDED - Payment has been refunded. Valid only for deposits.
SCHEDULED - Payment is scheduled funds are blocked, but some action is required. Check action response object property for details
ACCEPTED - Payment has been accepted by the recipient and will be automatically processed.

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, SCHEDULED, ACCEPTED, CANCELLED, REFUNDED]

Example: FAILED

statusReasonstring

Status reason when the purchase order has failed.

Possible values: <= 60 characters

slipIdstring

Slip identifier when a payment slip has been created for the purchase order.

nextStatusPayment Status (string)[]

Provides the next possible status update the client can request, depending on the chosen payment type and option.

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, SCHEDULED, ACCEPTED, CANCELLED, REFUNDED]

actionPayment Action (string)

Specifies action required to complete to be able to continue to the next payment status:

NONE – No action is required, you can proceed to the next deposit status.
REDIRECT – The user must be redirected in order to complete a payment, for example, when an alternate payment method like Paysafecard is used.
SCA - The user must complete a Strong Customer Authentication (SCA) process.
ONBOARD - A transfer-specific action is required. The recipient customer must be registered with the corresponding email address.
USER_INPUT - Additional information from the user is required to complete the payment.

Possible values: [NONE, REDIRECT, SCA, ONBOARD, USER_INPUT]

Default value: NONE

Example: NONE

scaDetails object

SCA authentication details, including information about the authentication process. It should be present in the response of any wallet operation that requires it due to PSD2 regulatory requirements.

Present in the response - operation requires SCA authentication, and the user should proceed with the SCA process.
Not present in the response - operation does not require SCA authentication and is authorized to proceed.

eventIdstringrequired

The distinct identifier for the SCA authentication event.

Example: 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

walletOperationIdstringrequired

The distinct identifier for the wallet operation. This identifier is used to associate the wallet operation with the SCA authentication event.

Example: a5865fd6-18c2-45a8-9953-1c00eac36c36

authenticationModeSCA Authentication Mode (string)required

Mode of the Strong Customer Authentication (SCA) authentication process.

OUTSOURCED - The partner is responsible for handling the entire SCA process.
EMBEDDED - Paysafe is responsible for handling the entire SCA process, including user authentication and compliance with regulations like PSD2.
HYBRID - Paysafe manages the entire SCA process, excluding the communication with the end-user.

Possible values: [OUTSOURCED, EMBEDDED, HYBRID]

Example: OUTSOURCED

availableVerificationsobject[]

List of available verifications for the SCA authentication event. If none are specified, the user can proceed with any agreed-upon verification method.

creationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

expirationTimestring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

discountDetails object

Available discount points balance and selectable discount options.

maxDiscountsintegerrequired

Maximum number of discounts that may be combined for one payment.

availablePoints object

Loyalty points balance available for use for the already evaluated discount options for this payment.

idstringrequired

Loyalty point ID (UUID). Same identifier used in the balance and reward-transactions APIs.

namestringrequired

Display name of the loyalty point (e.g. Redeemable Points, Member Points).

attributes object[]required

Key-value attributes for the loyalty point (e.g. overall, redeemable, type). Returns empty array when none are for the entity.

Array [

keystring

Attribute name (e.g. overall, redeemable, type).

valuestring

Attribute value for the key.

]

balanceintegerrequired

Current balance for this loyalty point for the profile.

options object[]

Selectable discount lines (points tiers, vouchers, or a no-discount option) with redemption metadata.

Array [

amountinteger<int64>required

Discount amount in minor currency units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

typestringrequired

Discount source type.

Possible values: [POINTS, VOUCHER]

redemption object

referencestringrequired

Stable reference for this discount tier or voucher (for example points amount as a string, voucher code, or 0 for no discount).

displayNamestring

Customer-facing label for the discount option in UI copy.

]

purchaseOrderDetails objectrequired

Details describing the external purchase order.

serviceCodestringrequired

External service reference for the purchase order (for example CIP code).

providerPurchaseOrderProvider (string)required

Identifies the external partner system that originated the purchase order (for example the upstream checkout or bill-pay channel). New enum values may be added when additional providers are supported.

Possible values: [PAGO_EFECTIVO]

categorystringrequired

Purchase order category (for example retail purchase).

Possible values: [PURCHASE]

descriptionstring

Free-text description shown in the payment preview.

creationTimestring<date-time>

Creation timestamp of the service code in the external provider system. It describes the external service code lifecycle only (not an Embedded Wallet domain creation timestamp) and is returned only when supplied by that external system.

Example: 2021-07-15T17:54:12Z

expirationTimestring<date-time>

Expiration timestamp of the service code in the external provider system. It describes the external service code lifecycle only (not an Embedded Wallet domain expiration timestamp) and is returned only when supplied by that external system.

Example: 2021-07-15T17:54:12Z

]

meta object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecordsinteger

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

Example: 1

limitinteger

This is the requested number of records to be returned per page.

Example: 10

offsetinteger

This is the requested starting position of the response, where 0 is the first record.

Example: 0

pageinteger

This is the page of records on which the lookup starts. The starting page is 1.

Example: 1

PurchaseOrderList
{
  "purchaseOrders": [
    {
      "id": "string",
      "amount": 0,
      "currencyCode": "EUR",
      "recipient": {
        "externalId": "string",
        "fullName": "string",
        "type": "CUSTOMER"
      },
      "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
      "paymentFunding": {
        "discounts": [
          {
            "amount": 0,
            "currencyCode": "EUR",
            "type": "POINTS",
            "redemption": {
              "reference": "string",
              "displayName": "string"
            }
          }
        ],
        "wallet": {
          "amount": 0,
          "currencyCode": "EUR"
        }
      },
      "fees": [
        {
          "amount": 1000,
          "currency": "EUR",
          "paymentReason": "OTHER_FEE"
        }
      ],
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:54:12Z",
      "status": "FAILED",
      "statusReason": "string",
      "slipId": "string",
      "nextStatus": [
        "FAILED"
      ],
      "action": "NONE",
      "scaDetails": {
        "eventId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
        "walletOperationId": "a5865fd6-18c2-45a8-9953-1c00eac36c36",
        "authenticationMode": "OUTSOURCED",
        "availableVerifications": [
          {
            "method": "OTP",
            "channel": "SMS",
            "target": "jo***@example.com",
            "action": {
              "language": "en",
              "returnUrl": "https://some-process.paysafe.com/",
              "redirectUrl": "https://some-process.paysafe.com/"
            }
          }
        ],
        "creationTime": "2021-07-15T17:54:12Z",
        "expirationTime": "2021-07-15T17:54:12Z"
      },
      "discountDetails": {
        "maxDiscounts": 0,
        "availablePoints": {
          "id": "string",
          "name": "string",
          "attributes": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "balance": 0
        },
        "options": [
          {
            "amount": 0,
            "currencyCode": "EUR",
            "type": "POINTS",
            "redemption": {
              "reference": "string",
              "displayName": "string"
            }
          }
        ]
      },
      "purchaseOrderDetails": {
        "serviceCode": "string",
        "provider": "PAGO_EFECTIVO",
        "category": "PURCHASE",
        "description": "string",
        "creationTime": "2021-07-15T17:54:12Z",
        "expirationTime": "2021-07-15T17:54:12Z"
      }
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}