Update a payment method

Requires the PAYMENT_METHOD.UPDATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdOrReferencestringRequiredDefaults to
The ID or reference of the resource.

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
referencestringOptionalformat: "^\S+$"0-256 characters
typeenum or nullOptional
cardobjectOptional
online_bankingobjectOptional
buy_now_pay_laterobjectOptional
direct_debitobjectOptional
digital_walletobjectOptional
customer_idstring or nullOptional
Resource ID of type CUSTOMER
integration_idstring or nullOptional
Resource ID of type INTEGRATION
integration_referencestring or nullOptional
integration_detailsobjectOptional
billing_addressobjectOptional
is_defaultboolean or nullOptional

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
created_atstring or nullOptionalRead-only
updated_atstring or nullOptionalRead-only
referencestringOptionalformat: "^\S+$"0-256 characters
statusenum or nullOptionalRead-only
typeenum or nullOptional
cardobjectOptional
online_bankingobjectOptional
buy_now_pay_laterobjectOptional
direct_debitobjectOptional
digital_walletobjectOptional
customer_idstring or nullOptional
Resource ID of type CUSTOMER
integration_idstring or nullOptional
Resource ID of type INTEGRATION
integration_referencestring or nullOptional
integration_detailsobjectOptional
billing_addressobjectOptional
is_defaultboolean or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error