Find Payment Method
The Find Payment Method API allows merchants to retrieve payment methods linked to a customer profile using the merchant-wallet-management scope. The response is filtered based on the merchant's configuration (e.g., only card or only bank account payment methods).
Quick Reference
- API Endpoint:
POST v1/payment-methods/search - Supported Scope:
merchant-wallet-management - Payment Method Types:
CARD,BANK_ACCOUNT - Key Fields:
customer,paymentMethodType,paymentMethodDetails,nickname,sourceProvider,default - Behavior:
- If customer not found, a new profile is created and an empty array is returned
- If customer found, returns payment methods associated with the profile and merchant configuration
- Error Codes: Refer Find Payment Method Error Codes
Handling Find Payment Method
- Retrieve all payment methods for a customer
- Filtered by merchant configuration (e.g., only cards or only bank accounts)
- Returns an empty array if no payment methods are found
Sample Request
Sample Request – Find Payment Method
{
"customer": {
"name": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"ssnLastFour": "string",
"phoneNumber": {
"countryCode": "string",
"number": "string"
},
"dateOfBirth": "2000-12-30",
"zip5": "99950",
"hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
"enterpriseId": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
}
}
Sample Response
Sample Response – Card
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"default": true,
"paymentMethodType": "CARD",
"nickname": "string",
"sourceProvider": {
"name": "CCG"
},
"paymentMethodDetails": {
"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "99950",
"manufacturerCard": true
}
}
Sample Response – Bank Account
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"default": true,
"paymentMethodType": "BANK_ACCOUNT",
"nickname": "string",
"sourceProvider": {
"name": "CCG"
},
"paymentMethodDetails": {
"type": "BANK_ACCOUNT",
"accountHolderType": "string",
"accountType": "string",
"status": "ACTIVE",
"bankName": "string",
"last4": "string",
"routingNumber": "string",
"nameOnAccount": "string"
}
}