Get the settlement wallet

GET

/v2/payments/collect/settlements/wallet

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns the crypto wallet your business's collected funds settle to.

Responses

OK

Content-Type

application/json

{

"id": "e2a4c6b8-0d1f-4e3a-b5c7-9d1e3f5a7b9c",

"name": "Treasury USDC",

"address": "0x7a2D4c9E1b3F5a8C0d6E2f4B9c1A3e5D7b9F0c2E",

"network": "Ethereum",

"currency": "USDC",

"beneficiaryName": "Acme Trading (Pty) Ltd",

"serviceProviderName": null

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No settlement wallet is set up for your business.
500	INTERNAL_ERROR	Unexpected error in the payments service.
502	-16097EXCHANGE_API_ERROR	The payments service failed to process the request.
502	EXCHANGE_API_ERROR	The payments service couldn't complete the request. Try again later.
503	-16099PAYMENTS_BACKEND_PROXY_DISABLED	Payments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.