Create Sender

Create a sender for use in payouts.

The response provides a unique sender ID, which you can use in place of the sender object for Create Payout.

Note

In addition to the required fields documented below, you must include all other sender fields listed in the response to , and you must conform to the regex provided. To create a sender that you can use with multiple payout methods, include all fields that are required by each payout method. The client is responsible for including all required fields.

Parameters

Request Header Parameters

Request Body Parameters

- company_name
- Name of the sender company. Relevant when entity_type is company.
- country
- Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
- currency
- Currency that the sender is paying with. Three-letter ISO 4217 code.
- entity_type
- Type of entity. One of the following values:
  - company
  - individual
- first_name
- First name of the sender. Relevant when entity_type is individual.
- identification_type
- Type of identification document for the sender. When entity_type is company, this field must be company_registered_number. When entity_type is individual, one of the following values:
  - drivers_license
  - identification_id
  - international_passport
  - residence_permit
  - social_security
  - work_permit
- identification_value
- Identification number on the document mentioned in identification_type.
- last_name
- Last name of the sender. Relevant when entity_type is individual.

Response Parameters

- address
- The address of the sender - street and number.
- city
- City where the sender is located.
- company_name
- Name of the sender company. Relevant when entity_type is company.
- country
- Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
- currency
- Currency that the sender is paying with. Three-letter ISO 4217 code.
- date_of_birth
- The date of birth of the sender. Relevant when entity_type is individual.
- entity_type
- Type of entity. One of the following values:
  - company
  - individual
- first_name
- First name of the sender. Relevant when entity_type is individual.
- id
- ID of the Sender object. String starting with sender_.
- identification_type
- Type of identification document for the sender. When entity_type is company, this field must be company_registered_number. When entity_type is individual, one of the following values:
  - drivers_license
  - identification_id
  - international_passport
  - residence_permit
  - social_security
  - work_permit
- identification_value
- Identification number on the document mentioned in identification_type.
- last_name
- Last name of the sender. Relevant when entity_type is individual.
- name
- Name of the sender. Relevant when entity_type is company.
- postcode
- Postal code of the sender.
- state
- State where the sender is located.

/v1/payouts/sender

Create Sender - individual

curl -X post
https://sandboxapi.rapyd.net/v1/payouts/sender
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "country": "US",
    "currency": "USD",
    "entity_type": "individual",
    "first_name": "Jane",
    "last_name": "Smith",
    "identification_type": "identification_id",
    "identification_value": "987654321",
    "date_of_birth": "12/12/2000",
    "address": "1 Second Street",
    "city": "Any Town",
    "state": "New State",
    "postcode": "12345"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "fb1a4dba-589d-4237-a7df-832e8bcde9d7"
    },
    "data": {
        "id": "sender_87a87cfef195f2e9418b7c582de653bc",
        "last_name": "Smith",
        "first_name": "Jane",
        "country": "US",
        "entity_type": "individual",
        "address": "1 Second Street",
        "name": "Jane Smith",
        "date_of_birth": "12/12/2000",
        "postcode": "12345",
        "city": "Any Town",
        "state": "New State",
        "currency": "USD",
        "identification_type": "identification_id",
        "identification_value": "987654321"
    }
}

Create Sender - company

curl -X post
https://sandboxapi.rapyd.net/v1/payouts/sender
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "company_name": "Four Star Professional Services",
    "country": "US",
    "currency": "USD",
    "entity_type": "company",
    "identification_type": "company_registered_number",
    "identification_value": "0123456789",
    "purpose_code": "transfer"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "af2e3d0a-b1f2-473d-bea0-3ba0c1d71b3e"
    },
    "data": {
        "id": "sender_8897b29d6e423fa5a16e9acec4a54a26",
        "country": "US",
        "entity_type": "company",
        "name": "Four Star Professional Services",
        "company_name": "Four Star Professional Services",
        "currency": "USD",
        "identification_type": "company_registered_number",
        "identification_value": "0123456789",
        "purpose_code": "transfer"
    }
}

In this section:

Documentation