Create bank payout

curl --request POST \
  --url https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amounts": {
    "debitedAmount": {
      "currency": "CURRENCY",
      "amount": 1000
    },
    "receivedAmount": {
      "currency": "CURRENCY",
      "amount": 1000
    }
  },
  "description": "Payment for services rendered",
  "ownReference": "PAY-2025-001234",
  "recipient": {
    "accountNumber": "ES9121000418450200051332",
    "address": {
      "city": "Barcelona",
      "country": "ES",
      "line1": "Calle Gran Via 123",
      "postalCode": "08001",
      "province": "Barcelona"
    },
    "beneficiaryType": "PERSON",
    "document": {
      "documentType": "NATIONAL_ID",
      "number": "87654321B"
    },
    "routingData": "IBAN",
    "abaRoutingCode": "021000021",
    "companyName": "Acme Corp S.L.",
    "contact": {
      "phone": "+34612345678"
    },
    "name": "Maria",
    "relation": "FRIEND",
    "surname": "Garcia",
    "swift": "BANKES"
  }
}
'

{
  "createdAt": "2025-01-15T10:30:00.000Z",
  "destination": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "detailUrl": "/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
  "displayType": "Transaction Type",
  "failedAt": "2025-01-15T10:35:00.000Z",
  "fee": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "fx": {
    "pair": "CURRENCY/CURRENCY",
    "rate": 1.08,
    "timestamp": "2025-01-15T10:30:00.000Z"
  },
  "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
  "isOTPRequired": true,
  "origin": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "reference": "PAY-2025-001234",
  "settledAt": "2025-01-15T10:35:00.000Z",
  "state": "PENDING",
  "type": "TRANSACTION_TYPE",
  "updatedAt": "2025-01-15T10:30:05.000Z"
}

Bank Payout

Create bank payout

Create a new bank payout. The order is created in “Created” state and may require OTP validation before being dispatched. Only one of amounts.debitedAmount.amount or amounts.receivedAmount.amount can be provided (set the other to 0). For PERSON recipients: document.documentType must be one of NATIONAL_ID, RESIDENCE_CARD, PASSPORT, DRIVING_LICENSE, CIF. Fields name, surname and relation are required. For BUSINESS recipients: document.documentType must be TAX_ID. Field companyName is required instead of name/surname. Field relation is ignored (defaults to COMERCIAL).

POST

api

account

users

{uid}

accounts

{aid}

bank-payouts

Create bank payout

curl --request POST \
  --url https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amounts": {
    "debitedAmount": {
      "currency": "CURRENCY",
      "amount": 1000
    },
    "receivedAmount": {
      "currency": "CURRENCY",
      "amount": 1000
    }
  },
  "description": "Payment for services rendered",
  "ownReference": "PAY-2025-001234",
  "recipient": {
    "accountNumber": "ES9121000418450200051332",
    "address": {
      "city": "Barcelona",
      "country": "ES",
      "line1": "Calle Gran Via 123",
      "postalCode": "08001",
      "province": "Barcelona"
    },
    "beneficiaryType": "PERSON",
    "document": {
      "documentType": "NATIONAL_ID",
      "number": "87654321B"
    },
    "routingData": "IBAN",
    "abaRoutingCode": "021000021",
    "companyName": "Acme Corp S.L.",
    "contact": {
      "phone": "+34612345678"
    },
    "name": "Maria",
    "relation": "FRIEND",
    "surname": "Garcia",
    "swift": "BANKES"
  }
}
'

{
  "createdAt": "2025-01-15T10:30:00.000Z",
  "destination": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "detailUrl": "/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
  "displayType": "Transaction Type",
  "failedAt": "2025-01-15T10:35:00.000Z",
  "fee": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "fx": {
    "pair": "CURRENCY/CURRENCY",
    "rate": 1.08,
    "timestamp": "2025-01-15T10:30:00.000Z"
  },
  "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
  "isOTPRequired": true,
  "origin": {
    "currency": "CURRENCY",
    "amount": 1000
  },
  "reference": "PAY-2025-001234",
  "settledAt": "2025-01-15T10:35:00.000Z",
  "state": "PENDING",
  "type": "TRANSACTION_TYPE",
  "updatedAt": "2025-01-15T10:30:05.000Z"
}

Authorizations

Authorization

string

header

required

API Key for accessing management endpoints

Path Parameters

uid

string

required

User ID

aid

string

required

Account ID

Body

application/json

Payout details

amounts

object

required

Show child attributes

description

string

required

Minimum string length: 3

Example:

"Payment for services rendered"

ownReference

string

required

Example:

"PAY-2025-001234"

recipient

object

required

Show child attributes

Response

Created

createdAt

string

Example:

"2025-01-15T10:30:00.000Z"

destination

object

Show child attributes

detailUrl

string

Example:

"/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"

displayType

string

Example:

"Transaction Type"

failedAt

string

Example:

"2025-01-15T10:35:00.000Z"

fee

object

Show child attributes

object

Show child attributes

string

Example:

"e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"

isOTPRequired

boolean

Example:

true

origin

object

Show child attributes

reference

string

Example:

"PAY-2025-001234"

settledAt

string

Example:

"2025-01-15T10:35:00.000Z"

state

string

Example:

"PENDING"

type

string

Example:

"TRANSACTION_TYPE"

updatedAt

string

Example:

"2025-01-15T10:30:05.000Z"

Simulate bank payout Send OTP via SMS