Fiat Withdrawals

Create Fiat Withdrawal

This endpoint allows the creation of a Fiat withdrawal. It will debit from the end user's currency's balance and withdraw such amount to the specified beneficiary account. This endpoint behaves asynchronously, don't expect the withdrawal to be completed after the request execution. To check for its completion, use the Retrieve Fiat Withdrawal endpoint. Updates for Fiat Withdrawals will be communicated via IPN webhooks. See IPN Webhooks in the documentation.

post/api/v1/fiat-withdrawals/

Request

  • Base URL: https://sandbox-b2b.ripio.com
  • URL: https://sandbox-b2b.ripio.com/api/v1/fiat-withdrawals/
  • Auth: OAuth 2 (client credentials, token URL https://sandbox-b2b.ripio.com/oauth2/token/, scopes: write)

Request body

end_user_idstring

End user's external ref

amountnumber

Amount to withdrawal. Is the amount that the destination account will receive.

external_refstring

An external identifier, usually a unique UUID

beneficiary_fiat_account_idstring

Indicates the beneficiary fiat account to be used as withdraw destination.

Response

Successful Response

idstring uuid

UUID used as fiat withdrawal identifier.

transaction_idstring uuid

UUID used as fiat withdrawal's transaction identifier.

created_atstring date-time

Indicates the fiat withdrawal creation date.

updated_atstring date-time

Indicates the fiat withdrawal's latest update date.

end_user_idstring

End user's external ref, usually a uuid. Identifies the user that owns this operation.

currency_codestring

Indicates the asset name involved in the fiat withdrawal.

amountstring

Indicates the fiat amount withdrawed.

status'PENDING' | 'COMPLETED' | 'CANCELLED'

Specifies the fiat withdrawal status.

external_refstring

Client side identification reference. Usually a UUID.

beneficiary_fiat_account_idstring uuid

UUID used as beneficiary fiat account identifier.

is_fiat_deposit_refundboolean

Shows if the fiat withdrawal corresponds to the refund of a fiat deposit.

refunded_fiat_depositstring uuid

UUID from a refunded fiat deposit, it could be null.

Changes

No recorded changes to this operation across all 1 revision of this API.