StatusLog In
API Reference and Guides

Sections

Theme switcher

/sandbox/payins

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Body Parameters

payinAddressIdstring Required

The Payin Address (linked to the wallet and account) to receive the funds).

Min length
38
Max length
100
Pattern
payinAddress_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
amountnumber Required

How much to payin in the lowest denomination of the currency.

sourceDetailsstring Required

Simulates the banking details for an inbound payin.

Max length
200
remitterDetailsstring Required

Simulates the remitter sending the funds for an inbound payin.

Max length
200
referencestring Required

Simulates the reference put on the bank transfer for an inbound payin.

Max length
200

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?