Create Deposit

Create a deposit request for a platform account in order to send funds into the account.

SecurityOAuth2: OAuth2Flow
Request
header Parameters
Authorization
string

OAuth bearer token (see authentication flows)

x-l2f-request-id
string

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

x-l2f-idempotency-id
string

Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json
deposit_type
required
string

How should the deposit be made. PUSH (manually sent by customer) or PULL (automatically pulled via a linked counterparty using a supported rail). If performing a PULL, several conditions apply.

Conditions:

  • The destination account must be for an asset type that supports pull deposits (e.g. USD, CAD)

  • The source counterparty must be linked and have an available rail that supports ones of the deposit mechanisms on the destination account (e.g. ACH, EFT).

  • The deposit request MUST be accepted using the /deposit/accept endpoint to initiate the pull deposit

required
object (DepositDestinationAccount)

Destination account on platform into which funds will be deposited

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/deposits
Request samples
application/json
{
  • "deposit_type": "PUSH",
  • "deposit_destination": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}
© 2024 Rail. All Rights Reserved.