Skip to main content

​
Overview

Receivers allow your users to send off-ramp or cross-ramp payouts to third parties. A receiver can be an individual person or a business entity. Once created, receivers can have bank accounts linked to them and can be referenced when creating off-ramp or cross-ramp transactions using the receiverId parameter.

​
Creating a Receiver

Use the Create Receiver endpoint to register a new receiver.

​
Required Fields (all receivers)

  • userId: The Capa user ID who owns this receiver
  • receiverType: Either INDIVIDUAL or BUSINESS
  • email: Email address of the receiver
  • taxId: Tax identification number (e.g., RFC for Mexico)

​
Individual Receivers

For receiverType: INDIVIDUAL, also provide:
  • firstName: First name
  • lastName: Last name
  • countryOfBirth: Country of birth (ISO 3166-1 alpha-2 code)
  • dateOfBirth (optional): Date of birth in ISO date format (e.g., 1990-01-15)
  • phoneNumber (optional): Phone number

​
Business Receivers

For receiverType: BUSINESS, also provide:
  • businessName: Legal name of the business
  • countryOfConstitution: Country of constitution (ISO 3166-1 alpha-2 code)
  • dateOfConstitution (optional): Date of constitution in ISO date format

​
Compliance Fields

  • isPep (optional): Whether the receiver is a Politically Exposed Person
  • hasBeneficialOwner (optional): Declaration of beneficial owner existence
  • hasResourceProvider (optional): Declaration of resource provider existence

​
Example: Creating an Individual Receiver

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "receiverType": "INDIVIDUAL",
  "email": "john.doe@example.com",
  "taxId": "RFC123456789",
  "firstName": "John",
  "lastName": "Doe",
  "countryOfBirth": "MX",
  "dateOfBirth": "1990-01-15",
  "isPep": false
}

​
Example: Creating a Business Receiver

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "receiverType": "BUSINESS",
  "email": "finance@techcompany.com",
  "taxId": "XAXX010101000",
  "businessName": "Tech Company S.A. de C.V.",
  "countryOfConstitution": "MX",
  "dateOfConstitution": "2020-01-01",
  "isPep": false
}

​
Listing Receivers

Use the List Receivers endpoint to retrieve all receivers for a specific user. Pass the userId as a query parameter. The response includes a paginated list with count and total fields.

​
Deleting a Receiver

Use the Delete Receiver endpoint to soft-delete (disable) a receiver. The receiver will no longer be available for new transactions, but existing transactions are not affected.

​
Adding Bank Accounts to Receivers

Once a receiver is created, you can link bank accounts to them using the Create Bank Account by Receiver endpoint. You can also list and delete receiver bank accounts: Bank account requirements vary by country:
CountryRequired Fields
MXaccountIdentifier (18-digit CLABE)
DOaccountIdentifier, bankName, accountType, documentIdentifier, documentType
USaccountIdentifier, bankName, routingNumber, accountHolder, address
SEPA (EU)iban, bic, bankName, accountHolder

​
Using Receivers in Transactions

When creating an off-ramp or cross-ramp transaction, pass the receiverId to direct the payout to the receiver instead of the user themselves. The receiver must belong to the specified user. See the Off-Ramp Guide and Cross-Ramp Guide for more details.
What’s Next