Cards & Wallets · Access Your Data

Manage Customers

Retrieve your customers and manage the payment methods saved against them.

Customer payment method endpoints

The endpoints below let you list, retrieve, update and remove saved payment methods for a customer. Make sure you respect the guidelines described in Saving cards for reuse when saving payment methods.

GET/acceptor/rest/customers/{instId}/{customerId}Get a customer#

description:

Retrieves a customer by platform customer identifier for the given installation

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier
customerId
stringMandatoryPlatform customer identifier

}

Responses

200Customer retrieved

response body:

shared schema advancedPayments/customer-resource

{

merchantRef
string (≤ 255 chars)Your reference for the Customer.
id
string (≤ 255 chars)Our ID for the Customer that is registered with us.
displayName
string (≤ 255 chars)The Customer's name.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
email
string (≤ 255 chars)Email address for the Customer.
dob
string (≤ 255 chars)Date of birth for the Customer.
dateOfBirth
string (date)
telephone
string (≤ 255 chars)Telephone number for the Customer.
defaultCurrency
string (≤ 255 chars)The Customer's default currency.
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

400Invalid installation identifier or customer identifier

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Customer not found

response body:

shared schema advancedPayments/customer-resource

{

merchantRef
string (≤ 255 chars)Your reference for the Customer.
id
string (≤ 255 chars)Our ID for the Customer that is registered with us.
displayName
string (≤ 255 chars)The Customer's name.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
email
string (≤ 255 chars)Email address for the Customer.
dob
string (≤ 255 chars)Date of birth for the Customer.
dateOfBirth
string (date)
telephone
string (≤ 255 chars)Telephone number for the Customer.
defaultCurrency
string (≤ 255 chars)The Customer's default currency.
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

GET/acceptor/rest/customers/{instId}/byRefFind a customer by merchant reference#

description:

Retrieves a customer for the given installation using the supplied merchant reference

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier

}

query parameters:

{

merchantRef
stringMandatoryMerchant reference used to identify the customer

}

Responses

200Customer retrieved

response body:

shared schema advancedPayments/customer-resource

{

merchantRef
string (≤ 255 chars)Your reference for the Customer.
id
string (≤ 255 chars)Our ID for the Customer that is registered with us.
displayName
string (≤ 255 chars)The Customer's name.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
email
string (≤ 255 chars)Email address for the Customer.
dob
string (≤ 255 chars)Date of birth for the Customer.
dateOfBirth
string (date)
telephone
string (≤ 255 chars)Telephone number for the Customer.
defaultCurrency
string (≤ 255 chars)The Customer's default currency.
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

400Invalid installation identifier or merchant reference

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Customer not found

response body:

shared schema advancedPayments/customer-resource

{

merchantRef
string (≤ 255 chars)Your reference for the Customer.
id
string (≤ 255 chars)Our ID for the Customer that is registered with us.
displayName
string (≤ 255 chars)The Customer's name.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
email
string (≤ 255 chars)Email address for the Customer.
dob
string (≤ 255 chars)Date of birth for the Customer.
dateOfBirth
string (date)
telephone
string (≤ 255 chars)Telephone number for the Customer.
defaultCurrency
string (≤ 255 chars)The Customer's default currency.
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

GET/acceptor/rest/customers/{instId}/{customerId}/paymentMethodsList payment methods#

description:

Retrieves all saved payment methods for the specified customer and installation

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier
customerId
stringMandatoryPlatform customer identifier

}

Responses

200Payment methods retrieved

response body:

shared schema advancedPayments/payment-method-resource

[ {

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

} ]

400Invalid installation identifier or customer identifier

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Customer not found

response body:

shared schema advancedPayments/payment-method-resource

[ {

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

} ]

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

POST/acceptor/rest/customers/{instId}/{customerId}/paymentMethod/{token}/makeDefaultMake a payment method default#

description:

Marks the specified saved payment method as the default for the customer and installation

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier
customerId
stringMandatoryPlatform customer identifier
token
stringMandatorySaved payment method token

}

request body:

{} — This call takes no request body — send an empty JSON object.

Responses

200Payment method marked as default

response body:

shared schema advancedPayments/payment-method-resource

{

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

400Invalid installation, customer, or payment method token

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Payment method not found

response body:

shared schema advancedPayments/payment-method-resource

{

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

POST/acceptor/rest/customers/{instId}/{customerId}/paymentMethods/{token}/updateUpdate a payment method#

description:

Updates the saved payment method details for the specified customer, token, and installation

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier
customerId
stringMandatoryPlatform customer identifier
token
stringMandatorySaved payment method token

}

request body:

shared schema advancedPayments/payment-method-update

{

isPrimary
booleanIndicates if the card being used should become the Customer's default card.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
card {
advancedPayments/cardUse if you are updating card details.
- cardNickname
  stringThe name the Customer provides for their card to allow easy selection where they register multiple cards.
- expiryDate
  string (pattern (\d{4})|REMOVE)The expiry date for the card. The value can't be updated when card is backed by a network token.
- validDate
  string (pattern (\d{4})|REMOVE)The valid from date of the card. Formatted as MMYY. The value can't be updated when card is backed by a network token.
- issueNumber
  stringThe issue number for the card. The value can't be updated when card is backed by a network token.
}
bankAccount {
advancedPayments/bank-account-update
- accountHolderName
  stringMandatoryThe name of the account holder.
}

}

Responses

200Payment method updated

response body:

shared schema advancedPayments/payment-method-resource

{

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

400Invalid installation, customer, token, or update request

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Payment method not found

response body:

shared schema advancedPayments/payment-method-resource

{

paymentClass
string (≤ 255 chars)ReturnedThe classification of payment method used. Eg. Card, Cash, PayPal.
card {
advancedPayments/card-response-detailPopulated if the payment method is card.
- cardToken
  stringThe token for the card.
- cardFingerprint
  stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
- cardType
  string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe scheme of card. Eg. VISA, MASTERCARD, AMEX.
- cardCategory
  stringPossible values: CREDIT, DEBIT, ELECTRON, COMMERCIAL, BUSINESS, CORPORATE, PURCHASING, SIGNIA, WORLD, FLEET, MAESTRO_INTL, MAESTRO_UK, MAESTRO_UK_DOM, LASERThe category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
- maskedPan
  string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
- expiryDate
  string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
- issuer
  string (≤ 255 chars)The Issuer of the card.
- issuerCountry
  string (≤ 255 chars)The country of the card Issuer.
- cardHolderName
  string (≤ 255 chars)The Cardholder's name.
- cardNickname
  string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
- issueNumber
  string (≤ 255 chars)The issue number of the card used in the request.
- validDate
  string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
- source
  stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
- networkToken {
  advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction
  - status
    stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction: ACTIVE - active and usable SUSPENDED - temporarily suspended, may be re-activated in future DELETED - permanently deleted; need to re-engage cardholder EXPIRED - expired, should be refreshed in future UNPROVISIONED - no token
  - usage
    stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction: PROVISIONED - transaction created a network token PROVISION_FAILED - tried to create a network token but failed USED - transaction used an existing network token
  - tokenError
    stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure: CARD_TOKENISATION_NOT_ALLOWED - card not supported (or, not at this time) DECLINED - card scheme or issuer refused to provision a network token SERVICE_UNAVAILABLE - scheme token service not available SYSTEM_ERROR - unspecified error attempting to provision
  - expiryDate
    stringToken expiry date. Formatted as MMYY.
  }
- new
  boolean
}
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
billingAddress {
advancedPayments/postal-address
- name
  string (≤ 255 chars)
- line1
  string (≤ 255 chars)Line 1 of the address.
- line2
  string (≤ 255 chars)Line 2 of the address.
- line3
  string (≤ 255 chars)Line 3 of the address.
- line4
  string (≤ 255 chars)Line 4 of the address.
- district
  string (≤ 255 chars)
- city
  string (≤ 255 chars)City of the address.
- state
  string (≤ 255 chars)
- region
  string (≤ 255 chars)Region of the address.
- postcode
  string (≤ 255 chars)Post Code of the address.
- country
  string (≤ 255 chars)Country name of the Customer's billing address.
- countryCode
  string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
bankAccount {
advancedPayments/bank-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- iban
  string
- bic
  string
- bankAccountToken
  string
}
phone {
advancedPayments/phone-account-response-detail
- accountHolderName
  string
- savedAccountToken
  string
- mobileNumber
  string
}
applepay {
advancedPayments/apple-pay-response-detail
- displayName
  string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
- transactionIdentifier
  string (≤ 255 chars)
- cardType
  string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
- cardUsageType
  stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The token for the card.
}
googlepay {
advancedPayments/google-pay-response-detailThis section will be returned for all Google Pay Android device token payments.
- displayName
  string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
- cardScheme
  stringPossible values: AMEX, DINERS, DISCOVER, VISA, MASTERCARD, JCB, LASERThe card scheme (VISA, Mastercard, Amex, etc)
- savedAccountToken
  string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
- cardDetails
  stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
- cardHolderName
  stringThe cardholder name for the Google Pay payment method
}
link [ {
advancedPayments/link
- href
  stringDirect link to the resource.
- rel
  stringIdentifies the relationship to the requested resource.
} ]

}

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

POST/acceptor/rest/customers/{instId}/{customerId}/paymentMethod/{token}/removeRemove a payment method#

description:

Removes the specified saved payment method for the customer and installation

authorization:HTTP Basic

content-type: application/json

path parameters:

{

instId
stringMandatoryInstallation identifier
customerId
stringMandatoryPlatform customer identifier
token
stringMandatorySaved payment method token

}

request body:

{} — This call takes no request body — send an empty JSON object.

Responses

200Payment method removed

400Invalid installation, customer, or payment method token

response body:

shared schema advancedPayments/validation-failure-outcome

{

status
stringReturnedPossible values: SUCCESS, FAILED, PROCESSINGThe overall outcome of the request.
reasonCode
string (≤ 255 chars)ReturnedA code indicating the overall outcome of the request. Refer to Errors for more information.
reasonMessage
string (≤ 255 chars)ReturnedA message indicating the overall outcome of the request. This is where we'll provide detailed reasons for any errors.
fieldErrors [ {
advancedPayments/field-error
- field
  string
- message
  string
} ]

}

401Unauthorized

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

403Access denied

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}

404Payment method not found

500Internal Server Error

response body:

shared schema advancedPayments/error-response

{

status
string
error
string
message
string
path
string
timestamp
string (date-time)

}