POST
/
api
/
v1
/
fiat-withdrawals
curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/fiat-withdrawals/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "end_user_id": "customer_10",
  "amount": 12345.67,
  "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029",
  "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc"
}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "end_user_id": "customer_10",
  "amount": "12345.67",
  "currency_code": "ARS",
  "status": "PENDING",
  "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029",
  "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc",
  "is_fiat_deposit_refund": false,
  "refunded_fiat_deposit": null
}

Authorizations

​
Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Body

​
end_user_id
string

End user's external ref

​
amount
number

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

​
external_ref
string

An external identifier, usually a unique UUID

​
beneficiary_fiat_account_id
string

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

Response

201 - application/json
Successful Response
​
id
string

UUID used as fiat withdrawal identifier.

​
transaction_id
string

UUID used as fiat withdrawal's transaction identifier.

​
created_at
string

Indicates the fiat withdrawal creation date.

​
updated_at
string

Indicates the fiat withdrawal's latest update date.

​
end_user_id
string

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

​
currency_code
string

Indicates the asset name involved in the fiat withdrawal.

​
amount
string

Indicates the fiat amount withdrawed.

​
status
enum<string>

Specifies the fiat withdrawal status.

Available options:
PENDING,
COMPLETED,
CANCELLED
​
external_ref
string

Client side identification reference. Usually a UUID.

Maximum length: 128
​
beneficiary_fiat_account_id
string

UUID used as beneficiary fiat account identifier.

​
is_fiat_deposit_refund
boolean

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

​
refunded_fiat_deposit
string

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