Payment methods
List payment methods for buyer
Returns a list of stored payment methods for a buyer in a summarized format.
Only payment methods that are compatible with at least one active payment
service in that region are shown.
GET
/buyers/payment-methods
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/payment-methods \
--header 'Authorization: <authorization>'
{
"items": [
{
"approval_target": "any",
"approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
"country": "US",
"currency": "USD",
"expiration_date": "11/25",
"has_replacement": "boolean",
"id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
"label": "1111",
"last_replaced_at": "2023-07-26T19:23:00.000+00:00",
"merchant_account_id": "default",
"method": "card",
"scheme": "visa",
"type": "payment-method"
}
]
}
This endpoint requires the payment-methods.read
or embed
scope.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
buyer_id
string
Filters the results to only the items for which the buyer
has an
id
that matches this value.
buyer_external_identifier
string
Filters the results to only the items for which the buyer
has an
external_identifier
that matches this value.
country
string
Filters the results to only the items which support this country code. A country is formatted as 2-letter ISO country code.
currency
string
Filters the results to only the items which support this currency code. A currency is formatted as 3-letter ISO currency code.
Response
200 - application/json
items
object[]
A list of stored payment methods in summarized format.
Was this page helpful?
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/payment-methods \
--header 'Authorization: <authorization>'
{
"items": [
{
"approval_target": "any",
"approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
"country": "US",
"currency": "USD",
"expiration_date": "11/25",
"has_replacement": "boolean",
"id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
"label": "1111",
"last_replaced_at": "2023-07-26T19:23:00.000+00:00",
"merchant_account_id": "default",
"method": "card",
"scheme": "visa",
"type": "payment-method"
}
]
}