PRprimer
Payment Methods API

List saved payment methods

Changed on

Retrieve a list of stored payment methods for a customer.

get/payment-instruments

Request

  • Base URL
    https://api.sandbox.primer.io
  • URL
    https://api.sandbox.primer.io/payment-instruments
  • Auth
    API key in header X-API-KEY

Query parameters

customer_idstring required

Return payment methods for this customer ID.

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

Example response

{
  "data": [
    {
      "createdAt": "2021-03-01T12:00:00.123456",
      "token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5",
      "tokenType": "MULTI_USE",
      "analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT",
      "paymentMethodType": "PAYMENT_CARD",
      "paymentMethodData": {
        "last4Digits": "1111",
        "expirationMonth": "12",
        "expirationYear": "2030",
        "cardholderName": "John Biggins",
        "network": "Visa",
        "networkTransactionId": "020210628190752",
        "accountFundingType": "DEBIT"
      },
      "customerId": "customer-123",
      "description": "My first card",
      "deleted": false,
      "default": true
    }
  ]
}

Changes

  • 6b60d7283338Revision changes
    • 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 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 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 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 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 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

    • 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 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 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 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 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 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 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

  • c9333ea84ea5Revision changes
    • info

      added the optional property //// to the response with the status