Get Payment Methods

Request

Get a list of available payment methods, which can be used to specify which payment method to use when creating a payment. The list of payment methods may change over time, so it is recommended to fetch this list dynamically when creating a payment, to allow the user select the payment method they want to use.

The list of payment methods is not guaranteed to be exhaustive, and special configuration is needed for most of the possible methods.

The default method which is a payment link, will always be available with the string ID 000000000000000000000000.

Security

OAuth2ClientCredentials(Required scopes: organization:payflow:create)

Query

test_modeboolean(Test Mode)

Default:false

X-Organization-Idstring(X-Organization-Id)

Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required.

GET

/payment-methods

curl -i -X GET \
  'https://api.spensepay.com/partner/payment-methods?test_mode=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Organization-Id: string'

Responses

List of available payment methods

Bodyapplication/json

Array [

idstring(Id)^[a-fA-F0-9]{24}$required

namestring(Name)required

profile_idsArray of strings(Profile Ids)

The IDs of the profiles that the payment method belongs to.

Default:[]

typestring(PartnerPaymentMethodType)required

The type of payment method. Can be extended to other types in the future.

Enum:"payment_link""terminal""invoice"

activeboolean(Active)

Whether the payment method is active. Recommend to display in-active payments, but as disabled. Can for example be inactive if a terminal is turned off.

Default:true

]

Response

[
  {
    "id": "000000000000000000000000",
    "name": "Payment link via SMS/Email",
    "type": "payment_link",
    "active": true
  }
]