GET
/
payment-method-definitions
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-method-definitions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "bank",
      "icon_url": "https://api.sandbox.example.gr4vy.app/assets/payment-method-definitions/bank.svg",
      "display_name": "Bank",
      "long_display_name": "Bank (BACS)",
      "method": "BACS"
    }
  ]
}

This endpoint requires the payment-method-definitions.read scope.

Authorizations

​
Authorization
string
header
required

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

Response

200
application/json
Returns a list of payment method definitions.

A list of available payment method definitions.

​
items
object[]

Definitions of a payment method including icon, label, etc.

Was this page helpful?

Suggest edits
Delete payment methodCreate a job