Skip to main content
POST
/
api
/
v1
/
customers
/
{customer_id}
/
payment_methods
Add a payment method
curl --request POST \
  --url https://payments.oaknetwork.org/api/v1/customers/{customer_id}/payment_methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "bank",
  "provider": "crowd_split",
  "bank_details": {
    "account_number": "12345678",
    "account_name": "John Doe",
    "bank_name": "Banco do Brasil",
    "branch_code": "0001",
    "account_type": "checking",
    "ispb": "00000000"
  }
}
'
{
  "msg": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "status": "<string>",
    "provider": "<string>",
    "chain": "<string>",
    "currency": "<string>",
    "source_currency": "<string>",
    "destination_currency": "<string>",
    "bank_account_type": "<string>",
    "bankDetails": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "accountType": "<string>",
      "bankName": "<string>",
      "branchCode": "<string>",
      "ispb": "<string>"
    }
  },
  "provider_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Path Parameters

​
customer_id
string<uuid>
required

Body

application/json

Create a payment method for a customer. Fields type, provider, currency, chain, and bank_account_type are case-insensitive.

​
type
enum<string>
required

Payment method type (case-insensitive)

Available options:
bank,
card,
pix,
customer_wallet,
liquidation_address
​
provider
string

Provider name (defaults to crowd_split for bank/pix/customer_wallet)

​
currency
string

Currency code

​
source_currency
string
​
destination_currency
string
​
payment_rail
string
​
bank_account_type
enum<string>
Available options:
checking,
savings,
payment
​
chain
string

Blockchain chain

​
external_account_id
string

Required for liquidation_address type

​
bank_details
object

Required for bank type

Response

Payment method created

​
msg
string
​
data
object
​
provider_message
string