v1

latestOpenAPI 3.0.02026-07-22290108.6 KB

Payer

V2/Payer

Get payment details for a user

Retrieves the registered bank account details for a user. Optionally filter by payment details ID.

get/v2/payer/{clientUserId}/payment-details

Path parameters

clientUserIdstring required

Example:user-123

The client user ID to get payment details for

Query parameters

paymentDetailsIdstring

Example:fa898aec-519c-46be-9b4c-e76ef4ff99d9

Optional ID of specific payment details to retrieve

Headers

x-api-keystring required

API key for authentication

Response

Payment details retrieved successfully

Example response

{
  "paymentDetails": [
    {
      "id": "fa898aec-519c-46be-9b4c-e76ef4ff99d9",
      "userId": "a25a4274-8f50-4579-b476-8f35b297d4ad",
      "bankName": "Chase",
      "accountName": "Gordon's Chase Business Account",
      "beneficiaryType": "business",
      "accountNumber": "253009233489",
      "routingNumber": "026013356",
      "currency": "usd",
      "status": "approved",
      "rails": "local"
    }
  ]
}