Payments API

Get a payment

Changed on Sep 30, 2026

Retrieve a payment by its ID.

get/payments/{id}

Request

Base URL
https://api.sandbox.primer.io
URL
https://api.sandbox.primer.io/payments/{id}
Auth
API key in header X-API-KEY

Path parameters

idstring required

ID of payment to retrieve.

Query parameters

expandstring[] nullable

A list of fields to expand, such as transactions.events.

Headers

X-API-VERSIONstring required

Example:2.4

Specifies the version of the API to use. This must be set to 2.4.

Response

Successful Response

idstring required

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

datestring date-time required

The date and time at which the payment was created in UTC format.

dateUpdatedstring date-time required

The date and time of the last payment update in UTC format.

An enumeration.

cardTokenType'CARD_PAN' | 'NETWORK_TOKEN' | 'PROCESSOR_TOKEN'

An enumeration.

orderIdstring required

Your reference for the payment.

currencyCode'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' required

3-letter currency code in <a href='https://en.wikipedia.org/wiki/ISO_4217#Active_codes'>ISO 4217</a> format, e.g. <code>USD</code> for US dollars.

The following currencies have been retired and will return a deprecation error on new payment or session creation requests: BGN, ZWL, ANG

amountinteger required

The amount you charged the customer, in minor units.

customerIdstring

The unique identifier for your customer.

metadataobject

Additional data to be used throughout the payment lifecycle.

Example response

{
  "transactions": [
    {
      "reason": "Item returned.",
      "events": [
        {
          "id": "46d25279-9d36-4237-8f45-2dc4e4e262d6",
          "processorEventId": "30B258847H402782C",
          "date": "2025-01-22T13:39:18.992928",
          "type": "CAPTURE_SUCCEEDED",
          "amount": 1234
        }
      ]
    }
  ],
  "riskData": {
    "fraudChecks": {
      "source": "FRAUD_PROVIDER"
    },
    "cvvCheck": {
      "source": "PROCESSOR"
    },
    "avsCheck": {
      "source": "PROCESSOR"
    }
  }
}

Changes

Sep 30, 20266b60d7283338 Revision changes
- breaking
  for the path request parameter id, the minLength was increased from 0 to 8
- breaking
  added the pattern ^[a-zA-Z0-9]{8,9}$ to the path request parameter id
- breaking
  the response property / became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property /// became optional for the status
- warning
  for the path request parameter id, the maxLength was set to 9
- warning
  added the new ADYEN_ALIPAY_PLUS enum value to the / response property for the response status
- warning
  added the new ADYEN_CASHAPP enum value to the / response property for the response status
- warning
  added the new ADYEN_KAKAOPAY enum value to the / response property for the response status
- warning
  added the new ADYEN_PAYPAY enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_BANK_TRANSFER enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_BLIK enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_CASHAPP enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_DANA enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_GCASH enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_GRABPAY enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_IDEAL enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_KAKAOPAY enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_KLARNA enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_OCTOPUS enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_P24 enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_PAYSAFECARD enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_PAYSAFECASH enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_PROMPTPAY enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_SEPA enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_SKRILL enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_TABBY enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_TWINT enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_WECHAT enum value to the / response property for the response status
- warning
  added the new AIRWALLEX_WERO enum value to the / response property for the response status
- warning
  added the new ALMA enum value to the / response property for the response status
- warning
  added the new CETELEM_BNPP_FINANCING enum value to the / response property for the response status
- warning
  added the new CHECKOUT_ACH enum value to the / response property for the response status
- warning
  added the new CHECKOUT_ALIPAY_CN enum value to the / response property for the response status
- warning
  added the new CHECKOUT_ALIPAY_HK enum value to the / response property for the response status
- warning
  added the new CHECKOUT_ALMA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_BANCONTACT enum value to the / response property for the response status
- warning
  added the new CHECKOUT_BENEFIT enum value to the / response property for the response status
- warning
  added the new CHECKOUT_BIZUM enum value to the / response property for the response status
- warning
  added the new CHECKOUT_DANA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_EPS enum value to the / response property for the response status
- warning
  added the new CHECKOUT_GCASH enum value to the / response property for the response status
- warning
  added the new CHECKOUT_IDEAL enum value to the / response property for the response status
- warning
  added the new CHECKOUT_KAKAOPAY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_KLARNA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_KNET enum value to the / response property for the response status
- warning
  added the new CHECKOUT_MBWAY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_MOBILEPAY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_MULTIBANCO enum value to the / response property for the response status
- warning
  added the new CHECKOUT_OCTOPUS enum value to the / response property for the response status
- warning
  added the new CHECKOUT_OMANNET enum value to the / response property for the response status
- warning
  added the new CHECKOUT_P24 enum value to the / response property for the response status
- warning
  added the new CHECKOUT_PAYNOW enum value to the / response property for the response status
- warning
  added the new CHECKOUT_PAYPAL enum value to the / response property for the response status
- warning
  added the new CHECKOUT_PINLESS_DEBIT enum value to the / response property for the response status
- warning
  added the new CHECKOUT_QPAY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_SEPA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_SEQURA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_STC_PAY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_SWISH enum value to the / response property for the response status
- warning
  added the new CHECKOUT_TABBY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_TAMARA enum value to the / response property for the response status
- warning
  added the new CHECKOUT_TNG enum value to the / response property for the response status
- warning
  added the new CHECKOUT_TRUEMONEY enum value to the / response property for the response status
- warning
  added the new CHECKOUT_TWINT enum value to the / response property for the response status
- warning
  added the new CHECKOUT_VENMO enum value to the / response property for the response status
- warning
  added the new CHECKOUT_VIPPS enum value to the / response property for the response status
- warning
  added the new CHECKOUT_WECHAT enum value to the / response property for the response status
- warning
  added the new DLOCAL_BANK_TRANSFER enum value to the / response property for the response status
- warning
  added the new DLOCAL_BOLETO enum value to the / response property for the response status
- warning
  added the new DLOCAL_KUESKI enum value to the / response property for the response status
- warning
  added the new DLOCAL_MERCADO_PAGO enum value to the / response property for the response status
- warning
  added the new DLOCAL_MOBICRED enum value to the / response property for the response status
- warning
  added the new DLOCAL_NUPAY enum value to the / response property for the response status
- warning
  added the new DLOCAL_OXXO enum value to the / response property for the response status
- warning
  added the new DLOCAL_PICPAY enum value to the / response property for the response status
- warning
  added the new DLOCAL_PIX enum value to the / response property for the response status
- warning
  added the new DLOCAL_PIX_AUTOMATICO enum value to the / response property for the response status
- warning
  added the new DLOCAL_SPEI enum value to the / response property for the response status
- warning
  added the new DLOCAL_TAMARA enum value to the / response property for the response status
- warning
  added the new DLOCAL_WECHAT enum value to the / response property for the response status
- warning
  added the new EFTPOS enum value to the //// response property for the response status
- warning
  added the new FINTECTURE_IMMEDIATE_TRANSFER enum value to the / response property for the response status
- warning
  added the new FINTECTURE_SMART_TRANSFER enum value to the / response property for the response status
- warning
  added the new FLOA_PAY enum value to the / response property for the response status
- warning
  added the new HITPAY enum value to the / response property for the response status
- warning
  added the new HITPAY_ATOME enum value to the / response property for the response status
- warning
  added the new HITPAY_GRABPAY enum value to the / response property for the response status
- warning
  added the new HITPAY_SHOPEEPAY enum value to the / response property for the response status
- warning
  added the new HITPAY_WECHAT enum value to the / response property for the response status
- warning
  added the new LOW_TRANSACTION_VALUE enum value to the // response property for the response status
- warning
  added the new NOMUPAY_ALIPAY enum value to the / response property for the response status
- warning
  added the new NOMUPAY_ALIPAY_PLUS enum value to the / response property for the response status
- warning
  added the new NOMUPAY_BLIK enum value to the / response property for the response status
- warning
  added the new NOMUPAY_GCASH enum value to the / response property for the response status
- warning
  added the new NOMUPAY_GRABPAY enum value to the / response property for the response status
- warning
  added the new NOMUPAY_P24 enum value to the / response property for the response status
- warning
  added the new NOMUPAY_SHOPEEPAY enum value to the / response property for the response status
- warning
  added the new NOMUPAY_SWISH enum value to the / response property for the response status
- warning
  added the new NOMUPAY_TRUSTLY enum value to the / response property for the response status
- warning
  added the new NOMUPAY_TWINT enum value to the / response property for the response status
- warning
  added the new NOMUPAY_WECHAT enum value to the / response property for the response status
- warning
  added the new NOMUPAY_WERO enum value to the / response property for the response status
- warning
  added the new NUVEI_ALIPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_BANCOMAT enum value to the / response property for the response status
- warning
  added the new NUVEI_BANK_TRANSFER enum value to the / response property for the response status
- warning
  added the new NUVEI_BIZUM enum value to the / response property for the response status
- warning
  added the new NUVEI_BLIK enum value to the / response property for the response status
- warning
  added the new NUVEI_CASHAPP enum value to the / response property for the response status
- warning
  added the new NUVEI_DANA enum value to the / response property for the response status
- warning
  added the new NUVEI_EPS enum value to the / response property for the response status
- warning
  added the new NUVEI_GCASH enum value to the / response property for the response status
- warning
  added the new NUVEI_GRABPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_IDEAL enum value to the / response property for the response status
- warning
  added the new NUVEI_KAKAOPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_KLARNA enum value to the / response property for the response status
- warning
  added the new NUVEI_MBWAY enum value to the / response property for the response status
- warning
  added the new NUVEI_MERCADO_PAGO enum value to the / response property for the response status
- warning
  added the new NUVEI_MOBILEPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_MULTIBANCO enum value to the / response property for the response status
- warning
  added the new NUVEI_MYBANK enum value to the / response property for the response status
- warning
  added the new NUVEI_NPP enum value to the / response property for the response status
- warning
  added the new NUVEI_OXXO enum value to the / response property for the response status
- warning
  added the new NUVEI_P24 enum value to the / response property for the response status
- warning
  added the new NUVEI_PAYNOW enum value to the / response property for the response status
- warning
  added the new NUVEI_PAYSAFECARD enum value to the / response property for the response status
- warning
  added the new NUVEI_PICPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_PROMPTPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_RIVERTY enum value to the / response property for the response status
- warning
  added the new NUVEI_SHOPEEPAY enum value to the / response property for the response status
- warning
  added the new NUVEI_SKRILL enum value to the / response property for the response status
- warning
  added the new NUVEI_SWISH enum value to the / response property for the response status
- warning
  added the new NUVEI_TRUSTLY enum value to the / response property for the response status
- warning
  added the new NUVEI_TWINT enum value to the / response property for the response status
- warning
  added the new NUVEI_VENMO enum value to the / response property for the response status
- warning
  added the new NUVEI_WECHAT enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_AMEX enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_ANCV enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_BANCOMAT enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_BANCONTACT enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_CUP enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_FLOA_PAY enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_IDEAL enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_JCB enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_KLARNA enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_MULTIBANCO enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_PAYPAL enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_SCT enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_SDD enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_SWISH enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_WECHAT enum value to the / response property for the response status
- warning
  added the new ONEPOINT6_WERO enum value to the / response property for the response status
- warning
  added the new PAYABL_BANCONTACT enum value to the / response property for the response status
- warning
  added the new PAYABL_BLIK enum value to the / response property for the response status
- warning
  added the new PAYABL_BOLETO enum value to the / response property for the response status
- warning
  added the new PAYABL_IDEAL enum value to the / response property for the response status
- warning
  added the new PAYABL_MULTIBANCO enum value to the / response property for the response status
- warning
  added the new PAYABL_OXXO enum value to the / response property for the response status
- warning
  added the new PAYABL_P24 enum value to the / response property for the response status
- warning
  added the new PAYABL_PAYSAFECARD enum value to the / response property for the response status
- warning
  added the new PAYABL_PIX enum value to the / response property for the response status
- warning
  added the new PAYABL_SEPA enum value to the / response property for the response status
- warning
  added the new PAYABL_SPEI enum value to the / response property for the response status
- warning
  added the new PAYABL_TRUSTLY enum value to the / response property for the response status
- warning
  added the new PAYABL_TWINT enum value to the / response property for the response status
- warning
  added the new PAYABL_WERO enum value to the / response property for the response status
- warning
  added the new PAYSAFE_BANK_TRANSFER enum value to the / response property for the response status
- warning
  added the new PAYSAFE_NETELLER enum value to the / response property for the response status
- warning
  added the new PAYSAFE_PAYSAFECARD enum value to the / response property for the response status
- warning
  added the new PAYSAFE_PAYSAFECASH enum value to the / response property for the response status
- warning
  added the new PAYSAFE_SKRILL enum value to the / response property for the response status
- warning
  added the new PAYSAFE_VENMO enum value to the / response property for the response status
- warning
  added the new PAY_NL_RIVERTY enum value to the / response property for the response status
- warning
  added the new PRIMER_TEST_APPLE_PAY enum value to the / response property for the response status
- warning
  added the new PRIMER_TEST_GOOGLE_PAY enum value to the / response property for the response status
- warning
  added the new PRIMER_TEST_KLARNA enum value to the / response property for the response status
- warning
  added the new PRIMER_TEST_PAYPAL enum value to the / response property for the response status
- warning
  added the new PRIMER_TEST_SOFORT enum value to the / response property for the response status
- warning
  added the new REVIEW enum value to the // response property for the response status
- warning
  added the new REVIEW enum value to the // response property for the response status
- warning
  added the new REVOLUT_PAY enum value to the / response property for the response status
- warning
  added the new REVOLUT_PAY_BY_BANK enum value to the / response property for the response status
- warning
  added the new SCALAPAY enum value to the / response property for the response status
- warning
  added the new SLE enum value to the response property for the response status
- warning
  added the new SLE enum value to the //// response property for the response status
- warning
  added the new SLE enum value to the // response property for the response status
- warning
  added the new STN enum value to the response property for the response status
- warning
  added the new STN enum value to the //// response property for the response status
- warning
  added the new STN enum value to the // response property for the response status
- warning
  added the new STRIPE_ACH enum value to the / response property for the response status
- warning
  added the new STRIPE_ALIPAY enum value to the / response property for the response status
- warning
  added the new STRIPE_CASHAPP enum value to the / response property for the response status
- warning
  added the new STRIPE_GRABPAY enum value to the / response property for the response status
- warning
  added the new STRIPE_KAKAOPAY enum value to the / response property for the response status
- warning
  added the new STRIPE_KLARNA enum value to the / response property for the response status
- warning
  added the new STRIPE_PIX enum value to the / response property for the response status
- warning
  added the new STRIPE_SEPA enum value to the / response property for the response status
- warning
  added the new STRIPE_WECHAT enum value to the / response property for the response status
- warning
  added the new THREE_DS_EXEMPTION enum value to the // response property for the response status
- warning
  added the new VED enum value to the response property for the response status
- warning
  added the new VED enum value to the //// response property for the response status
- warning
  added the new VED enum value to the // response property for the response status
- warning
  added the new VES enum value to the response property for the response status
- warning
  added the new VES enum value to the //// response property for the response status
- warning
  added the new VES enum value to the // response property for the response status
- warning
  added the new XCG enum value to the response property for the response status
- warning
  added the new XCG enum value to the //// response property for the response status
- warning
  added the new XCG enum value to the // response property for the response status
- warning
  added the new ZWG enum value to the response property for the response status
- warning
  added the new ZWG enum value to the //// response property for the response status
- warning
  added the new ZWG enum value to the // response property for the response status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the MRO enum value from the response property for the response status
- info
  removed the MRO enum value from the //// response property for the response status
- info
  removed the MRO enum value from the // response property for the response status
- info
  removed the XAG enum value from the response property for the response status
- info
  removed the XAG enum value from the //// response property for the response status
- info
  removed the XAG enum value from the // response property for the response status
- info
  removed the XAU enum value from the response property for the response status
- info
  removed the XAU enum value from the //// response property for the response status
- info
  removed the XAU enum value from the // response property for the response status
- info
  removed the XBA enum value from the response property for the response status
- info
  removed the XBA enum value from the //// response property for the response status
- info
  removed the XBA enum value from the // response property for the response status
- info
  removed the XBB enum value from the response property for the response status
- info
  removed the XBB enum value from the //// response property for the response status
- info
  removed the XBB enum value from the // response property for the response status
- info
  removed the XBC enum value from the response property for the response status
- info
  removed the XBC enum value from the //// response property for the response status
- info
  removed the XBC enum value from the // response property for the response status
- info
  removed the XBD enum value from the response property for the response status
- info
  removed the XBD enum value from the //// response property for the response status
- info
  removed the XBD enum value from the // response property for the response status
- info
  removed the XDR enum value from the response property for the response status
- info
  removed the XDR enum value from the //// response property for the response status
- info
  removed the XDR enum value from the // response property for the response status
- info
  removed the XFU enum value from the response property for the response status
- info
  removed the XFU enum value from the //// response property for the response status
- info
  removed the XFU enum value from the // response property for the response status
- info
  removed the XPD enum value from the response property for the response status
- info
  removed the XPD enum value from the //// response property for the response status
- info
  removed the XPD enum value from the // response property for the response status
- info
  removed the XPT enum value from the response property for the response status
- info
  removed the XPT enum value from the //// response property for the response status
- info
  removed the XPT enum value from the // response property for the response status
- info
  removed the XSU enum value from the response property for the response status
- info
  removed the XSU enum value from the //// response property for the response status
- info
  removed the XSU enum value from the // response property for the response status
- info
  removed the XTS enum value from the response property for the response status
- info
  removed the XTS enum value from the //// response property for the response status
- info
  removed the XTS enum value from the // response property for the response status
- info
  removed the XUA enum value from the response property for the response status
- info
  removed the XUA enum value from the //// response property for the response status
- info
  removed the XUA enum value from the // response property for the response status
Sep 9, 2026c9333ea84ea5 Revision changes
- info
  added the optional property /// to the response with the status

Operation history