Skip to main content
Create Receiver

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Headers

X-Wallet-Id
string

Names the distribution account this request acts on. Required when the tenant has more than one active account. With a single active account, or an API key scoped to exactly one account, it may be omitted.

Body

application/json
external_id
string
required

External identifier for the receiver

verifications
object[]
required

Verification requirements for the receiver

email
string<email>

Email address of the receiver

phone_number
string

Phone number of the receiver

Response

Receiver created successfully

id
string
Example:

"f83bb638-dda4-41e6-80c9-d03e6eec2aef"

phone_number
string
Example:

"+15552368475"

external_id
string
Example:

"usr12334"

email
string
Example:

"jdoe@mail.org"

created_at
string
Example:

"2023-02-03T10:45:51.000Z"

total_payments
string
Example:

"2"

successful_payments
string
Example:

"2"

failed_payments
string
Example:

"0"

canceled_payments
string
Example:

"0"

remaining_payments
string
Example:

"0"

registered_wallets
string
Example:

"1"

received_amounts
object[]
wallets
object[]