PaymentMethods

Delete a customer's payment method

delete

Delete this payment method

Authorizations

OAuth2ClientCredentials

OAuth2applicationRequired

Token URL:

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

delete

/customers/{id}/payment-methods/{method-id}

HTTPcURLJavaScriptPython

DELETE /customers/{id}/payment-methods/{method-id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "response": "text"
}

Change a customer's default payment method

patch

Change the customer's default payment method to this one

Authorizations

OAuth2ClientCredentials

OAuth2applicationRequired

Token URL:

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

patch

/customers/{id}/payment-methods/{method-id}/default

HTTPcURLJavaScriptPython

PATCH /customers/{id}/payment-methods/{method-id}/default HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "response": "text"
}

Create a customer bank account

post

Create a new bank account with the provided information. Only one of USAccountData or CAAccountData must be sent, matching AccountDataType.

Authorizations

OAuth2ClientCredentials

OAuth2applicationRequired

Token URL:

Body

application/json

Bank account information. Only one of USAccountData or CAAccountData must be sent, matching AccountDataType.

account_data_typestring · enumOptionalPossible values:

custom_namestringOptional

institution_namestringOptional

receiver_namestringOptional

subtypestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/customers/{id}/payment-methods/bank

HTTPcURLJavaScriptPython

POST /customers/{id}/payment-methods/bank HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "account_data_type": "us",
  "ca_account_data": {
    "account_number": "text",
    "institution_code": "text",
    "transit_number": "text"
  },
  "custom_name": "text",
  "institution_name": "text",
  "receiver_name": "text",
  "subtype": "checkings",
  "type": "depository",
  "us_account_data": {
    "account_number": "text",
    "routing_number": "text"
  }
}

{
  "id": "text"
}

Create a customer card

post

Create a new card with the provided tokenized information

Authorizations

OAuth2ClientCredentials

OAuth2applicationRequired

Token URL:

Body

application/json

Tokenized card information

card_provider_tokenstringOptional

custom_namestringOptional

providerstring · enumOptionalPossible values:

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/customers/{id}/payment-methods/card

HTTPcURLJavaScriptPython

POST /customers/{id}/payment-methods/card HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "address": {
    "city": "text",
    "country": "text",
    "country_code": "text",
    "postal_code": "text",
    "state": "text",
    "state_code": "text",
    "street_address": "text",
    "subpremise": "text"
  },
  "card_provider_token": "text",
  "custom_name": "text",
  "provider": "evervault"
}

{
  "id": "text"
}