Payment Source

March 21, 2025 ยท View on GitHub

The payment source definition.

Structure

PaymentSource

Fields

NameTypeTagsDescriptionGetterSetter
CardCardRequestOptionalThe payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.CardRequest getCard()setCard(CardRequest card)
TokenTokenOptionalThe tokenized payment source to fund a payment.Token getToken()setToken(Token token)
PaypalPaypalWalletOptionalA resource that identifies a PayPal Wallet is used for payment.PaypalWallet getPaypal()setPaypal(PaypalWallet paypal)
BancontactBancontactPaymentRequestOptionalInformation needed to pay using Bancontact.BancontactPaymentRequest getBancontact()setBancontact(BancontactPaymentRequest bancontact)
BlikBlikPaymentRequestOptionalInformation needed to pay using BLIK.BlikPaymentRequest getBlik()setBlik(BlikPaymentRequest blik)
EpsEpsPaymentRequestOptionalInformation needed to pay using eps.EpsPaymentRequest getEps()setEps(EpsPaymentRequest eps)
GiropayGiropayPaymentRequestOptionalInformation needed to pay using giropay.GiropayPaymentRequest getGiropay()setGiropay(GiropayPaymentRequest giropay)
IdealIdealPaymentRequestOptionalInformation needed to pay using iDEAL.IdealPaymentRequest getIdeal()setIdeal(IdealPaymentRequest ideal)
MybankMybankPaymentRequestOptionalInformation needed to pay using MyBank.MybankPaymentRequest getMybank()setMybank(MybankPaymentRequest mybank)
P24P24PaymentRequestOptionalInformation needed to pay using P24 (Przelewy24).P24PaymentRequest getP24()setP24(P24PaymentRequest p24)
SofortSofortPaymentRequestOptionalInformation needed to pay using Sofort.SofortPaymentRequest getSofort()setSofort(SofortPaymentRequest sofort)
TrustlyTrustlyPaymentRequestOptionalInformation needed to pay using Trustly.TrustlyPaymentRequest getTrustly()setTrustly(TrustlyPaymentRequest trustly)
ApplePayApplePayRequestOptionalInformation needed to pay using ApplePay.ApplePayRequest getApplePay()setApplePay(ApplePayRequest applePay)
GooglePayGooglePayRequestOptionalInformation needed to pay using Google Pay.GooglePayRequest getGooglePay()setGooglePay(GooglePayRequest googlePay)
VenmoVenmoWalletRequestOptionalInformation needed to pay using Venmo.VenmoWalletRequest getVenmo()setVenmo(VenmoWalletRequest venmo)

Example (as JSON)

{
  "card": {
    "name": "name6",
    "number": "number6",
    "expiry": "expiry4",
    "security_code": "security_code8",
    "billing_address": {
      "address_line_1": "address_line_12",
      "address_line_2": "address_line_28",
      "admin_area_2": "admin_area_28",
      "admin_area_1": "admin_area_14",
      "postal_code": "postal_code0",
      "country_code": "country_code8"
    }
  },
  "token": {
    "id": "id6",
    "type": "BILLING_AGREEMENT"
  },
  "paypal": {
    "vault_id": "vault_id0",
    "email_address": "email_address0",
    "name": {
      "given_name": "given_name2",
      "surname": "surname8"
    },
    "phone": {
      "phone_type": "OTHER",
      "phone_number": {
        "national_number": "national_number6"
      }
    },
    "birth_date": "birth_date8"
  },
  "bancontact": {
    "name": "name0",
    "country_code": "country_code0",
    "experience_context": {
      "brand_name": "brand_name2",
      "locale": "locale6",
      "shipping_preference": "NO_SHIPPING",
      "return_url": "return_url4",
      "cancel_url": "cancel_url6"
    }
  },
  "blik": {
    "name": "name2",
    "country_code": "country_code2",
    "email": "email4",
    "experience_context": {
      "brand_name": "brand_name2",
      "locale": "locale6",
      "shipping_preference": "NO_SHIPPING",
      "return_url": "return_url4",
      "cancel_url": "cancel_url6"
    },
    "level_0": {
      "auth_code": "auth_code8"
    },
    "one_click": {
      "auth_code": "auth_code0",
      "consumer_reference": "consumer_reference2",
      "alias_label": "alias_label6",
      "alias_key": "alias_key4"
    }
  }
}