Create a payment initiation
Create a payment initiation request. Yorlet supports two types of payment initiation: type=inbound_payment initiates a payment from an external bank account to a bank account in Yorlet, and type=outbound_payment initiates a payment from your bank account to an external bank account.
curl --request POST \
--url https://api.yorlet.com/v1/payment_initiations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"metadata": {},
"reference": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/payment_initiations"
payload = {
"amount": 123,
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"metadata": {},
"reference": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
type: 'inbound_payment',
inbound_payment: {type: 'customer', customer: '<string>'},
metadata: {},
reference: '<string>'
})
};
fetch('https://api.yorlet.com/v1/payment_initiations', 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://api.yorlet.com/v1/payment_initiations",
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([
'amount' => 123,
'type' => 'inbound_payment',
'inbound_payment' => [
'type' => 'customer',
'customer' => '<string>'
],
'metadata' => [
],
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.yorlet.com/v1/payment_initiations"
payload := strings.NewReader("{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.yorlet.com/v1/payment_initiations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/payment_initiations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "payment_initiation",
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"account": "<string>",
"deleted": false,
"amount": 123,
"currency": "gbp",
"metadata": {},
"reference": "<string>",
"status": "<string>"
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
- Option 1
- Option 2
The amount of the payment initiation in the smallest currency unit.
Three-letter ISO currency code, in lowercase.
gbp, sek inbound_payment Show child attributes
Show child attributes
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
A reference for the payment initiation. Alphanumeric, up to 18 characters.
1 - 18^[a-zA-Z0-9]*$Response
Returns the payment initiation object if the request succeeded.
- Option 1
- Option 2
- Option 3
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
payment_initiation inbound_payment The inbound payment details
Show child attributes
Show child attributes
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The amount of the payment initiation in the smallest currency unit.
Three-letter ISO currency code, in lowercase.
gbp, sek Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
A reference for the payment initiation.
The current status of the payment initiation.
Was this page helpful?
curl --request POST \
--url https://api.yorlet.com/v1/payment_initiations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"metadata": {},
"reference": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/payment_initiations"
payload = {
"amount": 123,
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"metadata": {},
"reference": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
type: 'inbound_payment',
inbound_payment: {type: 'customer', customer: '<string>'},
metadata: {},
reference: '<string>'
})
};
fetch('https://api.yorlet.com/v1/payment_initiations', 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://api.yorlet.com/v1/payment_initiations",
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([
'amount' => 123,
'type' => 'inbound_payment',
'inbound_payment' => [
'type' => 'customer',
'customer' => '<string>'
],
'metadata' => [
],
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.yorlet.com/v1/payment_initiations"
payload := strings.NewReader("{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.yorlet.com/v1/payment_initiations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/payment_initiations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"type\": \"inbound_payment\",\n \"inbound_payment\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"metadata\": {},\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "payment_initiation",
"type": "inbound_payment",
"inbound_payment": {
"type": "customer",
"customer": "<string>"
},
"account": "<string>",
"deleted": false,
"amount": 123,
"currency": "gbp",
"metadata": {},
"reference": "<string>",
"status": "<string>"
}