Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
A descriptive name to identify this payment method
"My Crypto Wallet"
The ID of the merchant to associate this payment method with.
"89a4b012-c3d4-45e6-f789-012345678901"
The ID of the customer to associate this payment method with.
Note: This is not the customerRefId
from the customer object, it is the customerId
"89a4b012-c3d4-45e6-f789-012345678901"
The blockchain network ID the payout destination is associated with.
Valid values:
1
(Ethereum)10
(Optimism)56
(BNB)137
(Polygon)8453
(Base)42220
(Celo)42161
(Arbitrum)900
(Solana)11155111
(Sepolia) - Only available on the demo environment901
(Solana Devnet) - Only available on the demo environment
x >= 1
1
The blockchain wallet address where payments will be sent from. Must be a valid address for the specified network.
"0x2593DFBD86F2A0e51500869D3b027C6e5Ee48365"
A base64 encoded JWT token containing a signature proving ownership of the wallet address being registered as a payment method.
"eyJzaWduYXR1cmUiOiIweDhjZTkyNjA4MWMyNGZhN2M1ZXJhODQ2ZGI5NWMzNDU1ODllNTBmMDMwYmJmRWhkYWQzMWY3N2Zja2YwNGxMNDgyMzVmMjUyYmYxOGFhYWMxMzIwNzNkNzZjNmM5NDI4ZjBjZDk1YmYwZDY1MGFmOTRkZDNhNmRlNDAxMWZmOWRlMWIiLCJib2R5IjoibG9vcGNyeXB0by54eXogd2FudHMgeW91IHRvIHNpZ24gaW4gd2l0aCB5b3VyIEV0aGVyZXVtIGFjY291bnQuXG5cbkkgYWNjZXB0IExvb3AgQ3J5cHRvIEluYydzIFRlcm1zIG9mIFNlcnZpY2VcblxuVVJJOiBodHRwOi8vbG9jYWxob3N0OjUxNzMvXG5XZWIzIFRva2VuIFZlcnNpb246IDJcbkNoYWluIElEOiAxMTE1NTExMVxuSXNzdWVkIEF0OiAyMDI1LTAxLTE0VDAyOjE5OjI5LjQ2NlpcbkV4cGlyYXRpb24gVGltZTogMjAyNS0wMS0xNVQw="
The token contract address for the payment type. Must be a valid token contract address for the specified network. Either 'tokenAddress' or 'tokenSymbol' must be provided.
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
The token symbol that identifies the token on the blockchain network. Must match the symbol of the token contract. Either 'tokenAddress' or 'tokenSymbol' must be provided.
"USDC"
Whether the payment method is the default payment method for wallet address. Defaults to true.
true
Response
Ok
The unique identifier for the payment method
"1234567890abcdef"
The unique identifier of the merchant this payment method is associated with
"67e55044-10b1-426f-9247-bb680e5fe0c8"
The name of the payment method
"My Crypto Wallet"
Whether the payment method is active or not. Inactive payment methods cannot be used for payins
true
The customers that are associated with the payment method
The blockchain network ID the payment method is associated with
1
The blockchain wallet address where payments will be sent from
"0x1234567890abcdef"
Whether the payment method is the default payment method for wallet address
true
The token associated with the payment method
The status of the payment method, including the wallet's balance and authorization status
The date the payment method record was created, represented as a Unix timestamp in seconds.
1716211200