API Reference

Create a Transfer

post
https://api.sandbox.keyrails.com/api/v1/transfers
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

PublicApiCreateCryptoToCryptoAndFiatPaymentRequestModel

source
object
required
destination
object
required
double
required

Receiver amount for the destination currency.

string | null

A memo to be included with the transfer.
This value will appear in the beneficiary bank’s memo or payment reference field. E.g Invoice number.

string | null

A unique ID from your system. It can be leveraged to be used as an idempotency key

uuid | null

The customerId of the Keyrails customer that you are moving funds on behalf of.

string
enum
required
Allowed:
documents
array of strings | null

Each entry is either:

  • a documentId returned by POST /api/v1/transfers/documents, or

  • Base64 encoded following the data-uri scheme i.e. data:application/pdf;base64,[base_64_encoded_file_contents]

Valid file types: .pdf

documents
string | null

Comment value for your internal process.

boolean | null

When true, the payment is created with PendingApproval status and held for approver review before processing.

boolean

Whether to use funds from the developer wallet to make the payment. Optional, defaults to false.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?