Payment Methods
A Payment Method represents the funding source that belongs to a Customer and is used to bind to one or several Payment Consents.
POST /api/v1/pa/payment_methods/createGET /api/v1/pa/payment_methods/{id}GET /api/v1/pa/payment_methodsPOST /api/v1/pa/payment_methods/{id}/updatePOST /api/v1/pa/payment_methods/{id}/disable
Create a Payment Method
POST /api/v1/pa/payment_methods/create
Create a Payment Method which can be referenced by Payment Consent.
Alternatively you can directly provide entire payload of new Payment Method when verifying the Payment Consent, and then a Payment Method will be generated for you automatically during the process, which can be re-used for other Payment Consent later.
The Customer this Payment Method belongs to. This Payment Method is automatically added to the Customer as one of the available Payment Methods. See Customers API for further details.
Unique request identifier specified by the merchant.
Type of the Payment Method.
cardapplepaygooglepayApple pay information. This must be provided if type is set to applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer.
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer.
Payment data from Apple Pay Payment Token.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Card number.
Authentication method.
The authentication method type. One of emv or three_ds.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Device manufacturer identifier.
Cardholder name.
Card information. This must be provided if type is set to card.
Additional information of external network token requestor. Should be provided when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer.
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Card holder name. Maximum length is 128.
Card number.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN. Default: PAN.
Google pay information. This must be provided if type is set to googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer.
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer.
A UTF-8 encoded, serialized JSON object with the keys specified.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Card number.
Authentication method.
The authentication method type. One of emv or three_ds.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Device manufacturer identifier.
Cardholder name.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
ACH Direct Debit information. Only provided when type is ach_direct_debit.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Apple pay information. Only provided when type is applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
BACS Direct Debit information. Only provided when type is bacs_direct_debit.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive.
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided.
Locality name, e.g., Apartment 123.
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
BECS Direct Debit information. Only provided when type is becs_direct_debit.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
Card information. Only provided when type is card.
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
Bank identify number of this card.
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Information for Korean Card.
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Time when the Payment Method was created.
The Customer this Payment Method belongs to.
EFT Direct Debit information. Only provided when type is eft_direct_debit.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
Google pay information. Only provided when type is googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
Unique identifier for the Payment Method.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant.
SEPA Direct Debit information. Only provided when type is sepa_direct_debit.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Status of the Payment Method. One of CREATED, DISABLED.
Type of the Payment Method. One of card, applepay, googlepay, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit, eft_direct_debit.
Time when the Payment Method was last updated.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/payment_methods/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "type": "card",> "card": {> "expiry_month": "03",> "expiry_year": "2030",> "number": "4035501000000008",> "name": "John Doe",> "number_type": "PAN",> "billing": {> "email": "[email protected]",> "phone_number": "+1 1234567890",> "first_name": "John",> "last_name": "Doe",> "address": {> "country_code": "US",> "city": "San Francisco",> "state": "CA",> "street": "1460 Mission St.#02W101",> "postcode": "94103"> }> }> },> "customer_id": "cus_hkpd1dsaklad5sa",> "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e">}'
1{2 "id": "mtd_hkpd1dsjklad5sa",3 "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e",4 "customer_id": "cus_hkpd1dsaklad5sa",5 "type": "card",6 "card": {7 "expiry_month": "03",8 "expiry_year": "2030",9 "name": "John Doe",10 "bin": "403550",11 "last4": "0008",12 "brand": "visa",13 "issuer_country_code": "US",14 "card_type": "CREDIT",15 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",16 "billing": {17 "first_name": "John",18 "last_name": "Doe",19 "email": "[email protected]",20 "phone_number": "+1 1234567890",21 "address": {22 "country_code": "US",23 "state": "CA",24 "city": "San Francisco",25 "street": "1460 Mission St.#02W101",26 "postcode": "94103"27 }28 },29 "issuer_name": "JPMorgan Chase",30 "is_commercial": false,31 "number_type": "PAN"32 },33 "status": "CREATED",34 "created_at": "2023-10-01T12:00:00+00:00",35 "updated_at": "2023-10-01T12:00:00+00:00"36}
Retrieve a Payment Method
GET /api/v1/pa/payment_methods/{id}
Retrieve Payment Method by unique identifier.
Payment Method unique identifier.
ACH Direct Debit information. Only provided when type is ach_direct_debit.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Apple pay information. Only provided when type is applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
BACS Direct Debit information. Only provided when type is bacs_direct_debit.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive.
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided.
Locality name, e.g., Apartment 123.
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
BECS Direct Debit information. Only provided when type is becs_direct_debit.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
Card information. Only provided when type is card.
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
Bank identify number of this card.
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Information for Korean Card.
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Time when the Payment Method was created.
The Customer this Payment Method belongs to.
EFT Direct Debit information. Only provided when type is eft_direct_debit.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
Google pay information. Only provided when type is googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
Unique identifier for the Payment Method.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant.
SEPA Direct Debit information. Only provided when type is sepa_direct_debit.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Status of the Payment Method. One of CREATED, DISABLED.
Type of the Payment Method. One of card, applepay, googlepay, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit, eft_direct_debit.
Time when the Payment Method was last updated.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/payment_methods/att_hkpd12a3456hi7' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "id": "mtd_hkpd1dsjklad5sa",3 "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e",4 "customer_id": "cus_hkpd1dsaklad5sa",5 "type": "card",6 "card": {7 "expiry_month": "03",8 "expiry_year": "2030",9 "name": "John Doe",10 "bin": "403550",11 "last4": "0008",12 "brand": "visa",13 "issuer_country_code": "US",14 "card_type": "CREDIT",15 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",16 "billing": {17 "first_name": "John",18 "last_name": "Doe",19 "email": "[email protected]",20 "phone_number": "+1 1234567890",21 "address": {22 "country_code": "US",23 "state": "CA",24 "city": "San Francisco",25 "street": "1460 Mission St.#02W101",26 "postcode": "94103"27 }28 },29 "issuer_name": "JPMorgan Chase",30 "is_commercial": false,31 "number_type": "PAN"32 },33 "status": "CREATED",34 "created_at": "2023-10-01T12:00:00+00:00",35 "updated_at": "2023-10-01T12:00:00+00:00"36}
List all Payment Methods
GET /api/v1/pa/payment_methods
List all Payment Methods.
Customer unique identifier of the Payment Methods.
The start time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Page number starting from 0.
Number of Payment Methods to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.
Payment Method status. One of CREATED, DISABLED.
The end time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment Method type, can be card, ach_direct_debit.
A flag which identifies whether there are more results.
List items.
ACH Direct Debit information. Only provided when type is ach_direct_debit.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Apple pay information. Only provided when type is applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
BACS Direct Debit information. Only provided when type is bacs_direct_debit.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive.
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided.
Locality name, e.g., Apartment 123.
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
BECS Direct Debit information. Only provided when type is becs_direct_debit.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
Card information. Only provided when type is card.
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
Bank identify number of this card.
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Information for Korean Card.
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Time when the Payment Method was created.
The Customer this Payment Method belongs to.
EFT Direct Debit information. Only provided when type is eft_direct_debit.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
Google pay information. Only provided when type is googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
Unique identifier for the Payment Method.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant.
SEPA Direct Debit information. Only provided when type is sepa_direct_debit.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Status of the Payment Method. One of CREATED, DISABLED.
Type of the Payment Method. One of card, applepay, googlepay, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit, eft_direct_debit.
Time when the Payment Method was last updated.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/payment_methods' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "id": "mtd_hkpd1dsjklad5sa",6 "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e",7 "customer_id": "cus_hkpd1dsaklad5sa",8 "type": "card",9 "card": {10 "expiry_month": "03",11 "expiry_year": "2030",12 "name": "John Doe",13 "bin": "403550",14 "last4": "0008",15 "brand": "visa",16 "issuer_country_code": "US",17 "card_type": "CREDIT",18 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",19 "billing": {20 "first_name": "John",21 "last_name": "Doe",22 "email": "[email protected]",23 "phone_number": "+1 1234567890",24 "address": {25 "country_code": "US",26 "state": "CA",27 "city": "San Francisco",28 "street": "1460 Mission St.#02W101",29 "postcode": "94103"30 }31 },32 "issuer_name": "JPMorgan Chase",33 "is_commercial": false,34 "number_type": "PAN"35 },36 "status": "CREATED",37 "created_at": "2023-10-01T12:00:00+00:00",38 "updated_at": "2023-10-01T12:00:00+00:00"39 }40 ]41}
Update a Payment Method
POST /api/v1/pa/payment_methods/{id}/update
Depending on the payment_method_type, you may update some of the details contained within.
Payment Method to update.
Card information. This must be provided.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer.
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Unique request identifier specified by the merchant.
ACH Direct Debit information. Only provided when type is ach_direct_debit.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Apple pay information. Only provided when type is applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
BACS Direct Debit information. Only provided when type is bacs_direct_debit.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive.
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided.
Locality name, e.g., Apartment 123.
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
BECS Direct Debit information. Only provided when type is becs_direct_debit.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
Card information. Only provided when type is card.
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
Bank identify number of this card.
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Information for Korean Card.
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Time when the Payment Method was created.
The Customer this Payment Method belongs to.
EFT Direct Debit information. Only provided when type is eft_direct_debit.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
Google pay information. Only provided when type is googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
Unique identifier for the Payment Method.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant.
SEPA Direct Debit information. Only provided when type is sepa_direct_debit.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Status of the Payment Method. One of CREATED, DISABLED.
Type of the Payment Method. One of card, applepay, googlepay, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit, eft_direct_debit.
Time when the Payment Method was last updated.
| Error status | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/payment_methods/mtd_hkpd1dsjklad5sa/update' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "card": {> "expiry_month": "03",> "expiry_year": "2035",> "billing": {> "email": "[email protected]",> "phone_number": "+1 1234567890",> "first_name": "John",> "last_name": "Doe",> "address": {> "country_code": "US",> "city": "San Francisco",> "state": "CA",> "street": "1460 Mission St.#02W101",> "postcode": "94103"> }> }> },> "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e">}'
1{2 "id": "mtd_hkpd1dsjklad5sa",3 "request_id": "ff59b8e3-ea26-4d69-8a2c-a072c02e5235",4 "customer_id": "cus_hkpd1dsaklad5sa",5 "type": "card",6 "card": {7 "expiry_month": "03",8 "expiry_year": "2035",9 "name": "John Doe",10 "bin": "403550",11 "last4": "0008",12 "brand": "visa",13 "issuer_country_code": "US",14 "card_type": "CREDIT",15 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",16 "billing": {17 "first_name": "John",18 "last_name": "Doe",19 "email": "[email protected]",20 "phone_number": "+1 1234567890",21 "address": {22 "country_code": "US",23 "state": "CA",24 "city": "San Francisco",25 "street": "1460 Mission St.#02W101",26 "postcode": "94103"27 }28 },29 "issuer_name": "JPMorgan Chase",30 "is_commercial": false,31 "number_type": "PAN"32 },33 "status": "CREATED",34 "created_at": "2023-10-01T12:00:00+00:00",35 "updated_at": "2023-10-01T12:00:00+00:00"36}
Disable a Payment Method
POST /api/v1/pa/payment_methods/{id}/disable
Disable Payment Method by unique identifier. The Payment Method status would become DISABLED.
Payment Method unique identifier.
Unique request identifier specified by the merchant.
ACH Direct Debit information. Only provided when type is ach_direct_debit.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Apple pay information. Only provided when type is applepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
BACS Direct Debit information. Only provided when type is bacs_direct_debit.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive.
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided.
Locality name, e.g., Apartment 123.
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
BECS Direct Debit information. Only provided when type is becs_direct_debit.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
Card information. Only provided when type is card.
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN.
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding).
Token requestor unique identifier (Provided by card schemes during onboarding).
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
Bank identify number of this card.
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Information for Korean Card.
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Time when the Payment Method was created.
The Customer this Payment Method belongs to.
EFT Direct Debit information. Only provided when type is eft_direct_debit.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
Google pay information. Only provided when type is googlepay.
Billing information.
The billing address as it appears on the credit card issuer’s records.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD.
Email address of the customer.
First name of the customer.
Last name of the customer.
Phone number of the customer.
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month.
Four digit number representing the card’s expiration year.
Authentication method.
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data.
Output from the Secure Element.
The PIN encrypted using the bank’s key.
3D-Secure authentication data.
Online payment cryptogram, as defined by 3-D Secure.
Electronic Commerce Indicator, as defined by 3-D Secure.
Bank identify number of this card.
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier.
Fingerprint of the card.
A boolean field referring whether the card is commercial or not.
Country code of the card issuer.
Issuer name.
Last four digits of the card number.
Cardholder name.
The card's type of payment. One of credit or debit.
Unique identifier for the Payment Method.
A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant.
SEPA Direct Debit information. Only provided when type is sepa_direct_debit.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Status of the Payment Method. One of CREATED, DISABLED.
Type of the Payment Method. One of card, applepay, googlepay, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit, eft_direct_debit.
Time when the Payment Method was last updated.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/payment_methods/att_hkpd12a3456hi7/disable' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7">}'
1{2 "id": "mtd_hkpd1dsjklad5sa",3 "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7",4 "customer_id": "cus_hkpd1dsaklad5sa",5 "type": "card",6 "card": {7 "expiry_month": "03",8 "expiry_year": "2030",9 "name": "John Doe",10 "bin": "403550",11 "last4": "0008",12 "brand": "visa",13 "issuer_country_code": "US",14 "card_type": "CREDIT",15 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",16 "billing": {17 "first_name": "John",18 "last_name": "Doe",19 "email": "[email protected]",20 "phone_number": "+1 1234567890",21 "address": {22 "country_code": "US",23 "state": "CA",24 "city": "San Francisco",25 "street": "1460 Mission St.#02W101",26 "postcode": "94103"27 }28 },29 "issuer_name": "JPMorgan Chase",30 "is_commercial": false,31 "number_type": "PAN"32 },33 "status": "DISABLED",34 "created_at": "2023-10-01T12:00:00+00:00",35 "updated_at": "2023-10-01T12:00:00+00:00"36}