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",
"recipient": {
"accountNumber": "ES9121000418450200051332",
"address": {
"city": "Barcelona",
"country": "ES",
"line1": "Calle Gran Via 123",
"postalCode": "08001",
"province": "Barcelona"
},
"bankCountry": "ES",
"beneficiaryType": "PERSON",
"document": {
"documentType": "NATIONAL_ID",
"number": "87654321B"
},
"routingData": "SEPA",
"abaRoutingCode": "021000021",
"bankCode": "ECOCSNDA",
"companyName": "Acme Corp S.L.",
"contact": {
"phone": "+34612345678"
},
"institutionNumber": "003",
"mobileMoneyOperator": "Orange",
"name": "Maria",
"nipCode": "000023",
"relation": "FRIEND",
"sortCode": "231470",
"surname": "Garcia",
"swift": "BANKES",
"transitNumber": "00011"
},
"ownReference": "PAY-2025-001234"
}
'import requests
url = "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts"
payload = {
"amounts": {
"debitedAmount": {
"currency": "CURRENCY",
"amount": 1000
},
"receivedAmount": {
"currency": "CURRENCY",
"amount": 1000
}
},
"description": "Payment for services rendered",
"recipient": {
"accountNumber": "ES9121000418450200051332",
"address": {
"city": "Barcelona",
"country": "ES",
"line1": "Calle Gran Via 123",
"postalCode": "08001",
"province": "Barcelona"
},
"bankCountry": "ES",
"beneficiaryType": "PERSON",
"document": {
"documentType": "NATIONAL_ID",
"number": "87654321B"
},
"routingData": "SEPA",
"abaRoutingCode": "021000021",
"bankCode": "ECOCSNDA",
"companyName": "Acme Corp S.L.",
"contact": { "phone": "+34612345678" },
"institutionNumber": "003",
"mobileMoneyOperator": "Orange",
"name": "Maria",
"nipCode": "000023",
"relation": "FRIEND",
"sortCode": "231470",
"surname": "Garcia",
"swift": "BANKES",
"transitNumber": "00011"
},
"ownReference": "PAY-2025-001234"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amounts: {
debitedAmount: {currency: 'CURRENCY', amount: 1000},
receivedAmount: {currency: 'CURRENCY', amount: 1000}
},
description: 'Payment for services rendered',
recipient: {
accountNumber: 'ES9121000418450200051332',
address: {
city: 'Barcelona',
country: 'ES',
line1: 'Calle Gran Via 123',
postalCode: '08001',
province: 'Barcelona'
},
bankCountry: 'ES',
beneficiaryType: 'PERSON',
document: {documentType: 'NATIONAL_ID', number: '87654321B'},
routingData: 'SEPA',
abaRoutingCode: '021000021',
bankCode: 'ECOCSNDA',
companyName: 'Acme Corp S.L.',
contact: {phone: '+34612345678'},
institutionNumber: '003',
mobileMoneyOperator: 'Orange',
name: 'Maria',
nipCode: '000023',
relation: 'FRIEND',
sortCode: '231470',
surname: 'Garcia',
swift: 'BANKES',
transitNumber: '00011'
},
ownReference: 'PAY-2025-001234'
})
};
fetch('https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amounts' => [
'debitedAmount' => [
'currency' => 'CURRENCY',
'amount' => 1000
],
'receivedAmount' => [
'currency' => 'CURRENCY',
'amount' => 1000
]
],
'description' => 'Payment for services rendered',
'recipient' => [
'accountNumber' => 'ES9121000418450200051332',
'address' => [
'city' => 'Barcelona',
'country' => 'ES',
'line1' => 'Calle Gran Via 123',
'postalCode' => '08001',
'province' => 'Barcelona'
],
'bankCountry' => 'ES',
'beneficiaryType' => 'PERSON',
'document' => [
'documentType' => 'NATIONAL_ID',
'number' => '87654321B'
],
'routingData' => 'SEPA',
'abaRoutingCode' => '021000021',
'bankCode' => 'ECOCSNDA',
'companyName' => 'Acme Corp S.L.',
'contact' => [
'phone' => '+34612345678'
],
'institutionNumber' => '003',
'mobileMoneyOperator' => 'Orange',
'name' => 'Maria',
'nipCode' => '000023',
'relation' => 'FRIEND',
'sortCode' => '231470',
'surname' => 'Garcia',
'swift' => 'BANKES',
'transitNumber' => '00011'
],
'ownReference' => 'PAY-2025-001234'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts"
payload := strings.NewReader("{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}"
response = http.request(request)
puts response.read_body{
"canceledAt": "2025-01-15T10:35:00Z",
"counterparty": "John Doe",
"createdAt": "2025-01-15T10:30:00Z",
"destination": {
"currency": "CURRENCY",
"amount": 1000
},
"detailUrl": "/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
"displayType": "Transaction Type",
"failedAt": "2025-01-15T10:35:00Z",
"fee": {
"currency": "CURRENCY",
"amount": 1000
},
"fx": {
"pair": "CURRENCY/CURRENCY",
"rate": 1.08,
"timestamp": "2025-01-15T10:30:00Z"
},
"id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
"isOTPRequired": true,
"origin": {
"currency": "CURRENCY",
"amount": 1000
},
"reference": "PAY-2025-001234",
"reversedAt": "2025-01-15T10:35:00Z",
"settledAt": "2025-01-15T10:35:00Z",
"state": "PENDING",
"type": "TRANSACTION_TYPE",
"updatedAt": "2025-01-15T10:30:05Z"
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}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
/
v1
/
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",
"recipient": {
"accountNumber": "ES9121000418450200051332",
"address": {
"city": "Barcelona",
"country": "ES",
"line1": "Calle Gran Via 123",
"postalCode": "08001",
"province": "Barcelona"
},
"bankCountry": "ES",
"beneficiaryType": "PERSON",
"document": {
"documentType": "NATIONAL_ID",
"number": "87654321B"
},
"routingData": "SEPA",
"abaRoutingCode": "021000021",
"bankCode": "ECOCSNDA",
"companyName": "Acme Corp S.L.",
"contact": {
"phone": "+34612345678"
},
"institutionNumber": "003",
"mobileMoneyOperator": "Orange",
"name": "Maria",
"nipCode": "000023",
"relation": "FRIEND",
"sortCode": "231470",
"surname": "Garcia",
"swift": "BANKES",
"transitNumber": "00011"
},
"ownReference": "PAY-2025-001234"
}
'import requests
url = "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts"
payload = {
"amounts": {
"debitedAmount": {
"currency": "CURRENCY",
"amount": 1000
},
"receivedAmount": {
"currency": "CURRENCY",
"amount": 1000
}
},
"description": "Payment for services rendered",
"recipient": {
"accountNumber": "ES9121000418450200051332",
"address": {
"city": "Barcelona",
"country": "ES",
"line1": "Calle Gran Via 123",
"postalCode": "08001",
"province": "Barcelona"
},
"bankCountry": "ES",
"beneficiaryType": "PERSON",
"document": {
"documentType": "NATIONAL_ID",
"number": "87654321B"
},
"routingData": "SEPA",
"abaRoutingCode": "021000021",
"bankCode": "ECOCSNDA",
"companyName": "Acme Corp S.L.",
"contact": { "phone": "+34612345678" },
"institutionNumber": "003",
"mobileMoneyOperator": "Orange",
"name": "Maria",
"nipCode": "000023",
"relation": "FRIEND",
"sortCode": "231470",
"surname": "Garcia",
"swift": "BANKES",
"transitNumber": "00011"
},
"ownReference": "PAY-2025-001234"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amounts: {
debitedAmount: {currency: 'CURRENCY', amount: 1000},
receivedAmount: {currency: 'CURRENCY', amount: 1000}
},
description: 'Payment for services rendered',
recipient: {
accountNumber: 'ES9121000418450200051332',
address: {
city: 'Barcelona',
country: 'ES',
line1: 'Calle Gran Via 123',
postalCode: '08001',
province: 'Barcelona'
},
bankCountry: 'ES',
beneficiaryType: 'PERSON',
document: {documentType: 'NATIONAL_ID', number: '87654321B'},
routingData: 'SEPA',
abaRoutingCode: '021000021',
bankCode: 'ECOCSNDA',
companyName: 'Acme Corp S.L.',
contact: {phone: '+34612345678'},
institutionNumber: '003',
mobileMoneyOperator: 'Orange',
name: 'Maria',
nipCode: '000023',
relation: 'FRIEND',
sortCode: '231470',
surname: 'Garcia',
swift: 'BANKES',
transitNumber: '00011'
},
ownReference: 'PAY-2025-001234'
})
};
fetch('https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amounts' => [
'debitedAmount' => [
'currency' => 'CURRENCY',
'amount' => 1000
],
'receivedAmount' => [
'currency' => 'CURRENCY',
'amount' => 1000
]
],
'description' => 'Payment for services rendered',
'recipient' => [
'accountNumber' => 'ES9121000418450200051332',
'address' => [
'city' => 'Barcelona',
'country' => 'ES',
'line1' => 'Calle Gran Via 123',
'postalCode' => '08001',
'province' => 'Barcelona'
],
'bankCountry' => 'ES',
'beneficiaryType' => 'PERSON',
'document' => [
'documentType' => 'NATIONAL_ID',
'number' => '87654321B'
],
'routingData' => 'SEPA',
'abaRoutingCode' => '021000021',
'bankCode' => 'ECOCSNDA',
'companyName' => 'Acme Corp S.L.',
'contact' => [
'phone' => '+34612345678'
],
'institutionNumber' => '003',
'mobileMoneyOperator' => 'Orange',
'name' => 'Maria',
'nipCode' => '000023',
'relation' => 'FRIEND',
'sortCode' => '231470',
'surname' => 'Garcia',
'swift' => 'BANKES',
'transitNumber' => '00011'
],
'ownReference' => 'PAY-2025-001234'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts"
payload := strings.NewReader("{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-revo-api.raliopay.com/api/v1/account/users/{uid}/accounts/{aid}/bank-payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amounts\": {\n \"debitedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n },\n \"receivedAmount\": {\n \"currency\": \"CURRENCY\",\n \"amount\": 1000\n }\n },\n \"description\": \"Payment for services rendered\",\n \"recipient\": {\n \"accountNumber\": \"ES9121000418450200051332\",\n \"address\": {\n \"city\": \"Barcelona\",\n \"country\": \"ES\",\n \"line1\": \"Calle Gran Via 123\",\n \"postalCode\": \"08001\",\n \"province\": \"Barcelona\"\n },\n \"bankCountry\": \"ES\",\n \"beneficiaryType\": \"PERSON\",\n \"document\": {\n \"documentType\": \"NATIONAL_ID\",\n \"number\": \"87654321B\"\n },\n \"routingData\": \"SEPA\",\n \"abaRoutingCode\": \"021000021\",\n \"bankCode\": \"ECOCSNDA\",\n \"companyName\": \"Acme Corp S.L.\",\n \"contact\": {\n \"phone\": \"+34612345678\"\n },\n \"institutionNumber\": \"003\",\n \"mobileMoneyOperator\": \"Orange\",\n \"name\": \"Maria\",\n \"nipCode\": \"000023\",\n \"relation\": \"FRIEND\",\n \"sortCode\": \"231470\",\n \"surname\": \"Garcia\",\n \"swift\": \"BANKES\",\n \"transitNumber\": \"00011\"\n },\n \"ownReference\": \"PAY-2025-001234\"\n}"
response = http.request(request)
puts response.read_body{
"canceledAt": "2025-01-15T10:35:00Z",
"counterparty": "John Doe",
"createdAt": "2025-01-15T10:30:00Z",
"destination": {
"currency": "CURRENCY",
"amount": 1000
},
"detailUrl": "/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
"displayType": "Transaction Type",
"failedAt": "2025-01-15T10:35:00Z",
"fee": {
"currency": "CURRENCY",
"amount": 1000
},
"fx": {
"pair": "CURRENCY/CURRENCY",
"rate": 1.08,
"timestamp": "2025-01-15T10:30:00Z"
},
"id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
"isOTPRequired": true,
"origin": {
"currency": "CURRENCY",
"amount": 1000
},
"reference": "PAY-2025-001234",
"reversedAt": "2025-01-15T10:35:00Z",
"settledAt": "2025-01-15T10:35:00Z",
"state": "PENDING",
"type": "TRANSACTION_TYPE",
"updatedAt": "2025-01-15T10:30:05Z"
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}{
"error": {
"code": "INVALID_REQUEST",
"details": [
{
"field": "<string>",
"message": "<string>"
}
],
"message": "<string>",
"type": "VALIDATION_ERROR"
}
}Authorizations
API Key for accessing management endpoints
Headers
Idempotency key for safely retrying requests
Body
application/json
Payout details
Response
Created
Example:
"2025-01-15T10:35:00Z"
Counterparty is the party on the other side of the order, resolved per operation type: sender/cardholder for incomes, recipient/destination for expenses. May be empty when not available.
Example:
"John Doe"
Example:
"2025-01-15T10:30:00Z"
Show child attributes
Show child attributes
Example:
"/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"
Example:
"Transaction Type"
Example:
"2025-01-15T10:35:00Z"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"
Example:
true
Show child attributes
Show child attributes
Example:
"PAY-2025-001234"
Example:
"2025-01-15T10:35:00Z"
Example:
"2025-01-15T10:35:00Z"
Example:
"PENDING"
Example:
"TRANSACTION_TYPE"
Example:
"2025-01-15T10:30:05Z"