Payment Request v1.0

Payment Request v1.0 Specification

Version 1.0

Field

Description

Example

Mandatory

version

Payment Request version

1.0

destination.alias

Payee alias

@merchant1

source.alias

Payer alias

@user1

amount

Payment amount

100.12

asset

Payment currency

USD

description

Payment description

Order #1

Static Payment Requests

Static Payment Requests contain only information about the payee, the receiver of payment and lack the information about exact amounts and payment reference. Example of Static Payment Requests are QR codes exposed at Merchant stores. Payer use this Payment Request to initiate the payment flow, yet needs to add additional information about the exact amount and reference of payment.


{
	version: "1.0",
	destination: {
		alias: "@merchant_alias"
	},
	description: "Static Payment Request Example",
	data: {
		store: "Store name",
		merchant: "Merchant name",
	}
}

Dynamic Payment Requests

Dynamic Payment Requests contain both complete information about the payee and the information about exact amounts and payment reference. Example of Dynamic Payment Requests are QR codes generated at checkout process on e-commerce platforms or printed on POS devices. Payer use this Payment Request to initiate the payment flow with known total amount and reference of payment.


{
	version: "1.0",
	destination: {
		alias: "@merchant_alias"
	},
	asset: "USD",
	amount: 100.24,
	description: "Dynamic Payment Request Example",
	data: {
		store: "Store name",
		merchant: "Merchant name",
		order: "ord_uh2232i"
	}
}

Direct Payment Requests

Direct Payment Requests contain complete information about the payee, payer and the information about exact amounts and payment reference. Example of Direct Payment Requests are subscriptions and recurring payments. Payer receives notification about Payment Request and initiates the payment flow with known total amount and reference of payment.


{
	version: "1.0",
	destination: {
		alias: "@merchant_alias"
	},
	asset: "USD",
	amount: 100.24,
	description: "Dynamic Payment Request Example",
	data: {
		source: [
		   {
			alias: "@alice",
			amount: 50
	   	   },
		   {
			alias: "@bob",
			amount: 50.24
	   	   },
		],
		store: "Store name",
		merchant: "Merchant name",
		order: "ord_uh2232i"
	}
}

Create Payment Request v1.0

When creating new Apps.Payment you can use additional fields.

Use data object to add custom fields and data.

Use description object to add custom description.

Use data.valid_until to define expiry for this Payment Request. Any transaction sent will change status to LATE.

Use data.not_before to define if there is start date to accept payments for this Payment Request. Any transaction sent will change status to EARLY.

echo 'Create payment request'

curl --location --request POST 'https://api.orangepill.cloud/v1/apps/payment' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933dffabb' \
--header 'Content-Type: application/json' \
--data-raw '{
	"version": "1.0",
	"destination": {
		"alias": "@pet_shop_barney"
	},
	"amount": 100.23,
	"asset": "USD",
	"description": "Order ord_24hhh32 from WooCommerce",
	"data": {
		"system": "WOOCOMMERCE",
		"callback": "https://domain.com/orangepill/payments",
		"store": "Pet shop Barney",
		"merchant": "Pet shop Ltd.",
		"order": "ord_24hhh32"
	}   
}'

In response we get new Payment Request object.

{
	"id": "MljzDk8qxDsBkXW0wv3r",
	"version": "1.0",
	"destination": {
		"alias": "@pet_shop_barney"
	},
	"amount": 100.23,
	"asset": "USD",
	"description": "Order ord_24hhh32 from WooCommerce",
	"data": {
		"system": "WOOCOMMERCE",
		"callback": "https://domain.com/orangepill/payments",		
		"store": "Pet shop Barney",
		"merchant": "Pet shop Ltd.",
		"order": "ord_24hhh32"
	},   
	"status": "CREATED",
	"owner": "639675ab191e9023f356dfa6",
   	"created_at": 1671242774572,
   	"error": null
}

Get Payment Request details

You can get details of Payment Requests by providing id.

echo 'get Payment Request with id MljzDk8qxDsBkXW0wv3r'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment/MljzDk8qxDsBkXW0wv3r' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get Payment Request entity.

{
	"id": "MljzDk8qxDsBkXW0wv3r",
	"version": "1.0",
	"destination": {
		"alias": "@pet_shop_barney"
	},
	"amount": 100.23,
	"asset": "USD",
	"description": "Order ord_24hhh32 from WooCommerce",
	"data": {
		"system": "WOOCOMMERCE",
		"callback": "https://domain.com/orangepill/payments",		
		"store": "Pet shop Barney",
		"merchant": "Pet shop Ltd.",
		"order": "ord_24hhh32"
	},   
	"status": "CREATED",
	"owner": "639675ab191e9023f356dfa6",
   	"created_at": 1671242774572,
   	"error": null
}

Delete Payment Request

To delete Payment Request use following call.

echo 'Delete payment request'

curl --location --request DELETE 'https://api.orangepill.cloud/v1/apps/payment/MljzDk8qxDsBkXW0wv3r' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \

In response we get id of deleted Payment Request object.

"MljzDk8qxDsBkXW0wv3r"

List Payment Requests

You can list all Payment Requests or filter them using query method..

echo 'list Payment Requests with status DONE'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment?query={"status":"DONE"}' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get array of Payment Requests.

[
	{
		"id": "MljzDk8qxDsBkXW0wv3r",
		"version": "1.0",
		"destination": {
			"alias": "@pet_shop_barney"
		},
		"amount": 100.23,
		"asset": "USD",
		"description": "Order ord_24hhh32 from WooCommerce",
		"data": {
			"system": "WOOCOMMERCE",
			"callback": "https://domain.com/orangepill/payments",			
			"store": "Pet shop Barney",
			"merchant": "Pet shop Ltd.",
			"order": "ord_24hhh32"
		},   
		"status": "DONE",
		"owner": "639675ab191e9023f356dfa6",
	   	"created_at": 1671242774572,
	   	"error": null
	},
	{
		"id": "XW0wv3rzDk8jqxDMlsBk",
		"version": "1.0",
		"destination": {
			"alias": "@pet_shop_barney"
		},
		"amount": 200.23,
		"asset": "USD",
		"description": "Order ord_36yhgh11 from WooCommerce",
		"data": {
			"system": "WOOCOMMERCE",
			"callback": "https://domain.com/orangepill/payments",			
			"store": "Pet shop Barney",
			"merchant": "Pet shop Ltd.",
			"order": "ord_36yhgh11"
		},   
		"status": "DONE",
		"owner": "639675ab191e9023f356dfa6",
	   	"created_at": 1712427674572,
	   	"error": null
	}
]

Generate QR Code for URL

You can encode URL as QR code. Use it to generate code with link for conversational channels like WhatsApp or custom URL for your mobile application.

Use endpoint GET /v1/apps/payment/qr/:format/:width/:data to get image of QR code form Orangepill platform.

Supported formats are png and base64.

Use parameter width to define the size of QR code.
Use parameter data to provide URL you want to encode.

Use encodeUrl method for data parameter. For example URL https://wa.me/447860034005?text=payment code q0YR6lzpXJiNo5GMjwXk should be encoded like https%3A%2F%2Fwa.me%2F447860034005%3Ftext%3Dpayment%2520code%2520q0YR6lzpXJiNo5GMjwXk.

PNG format of QR Code

echo 'Generate 200x200px PNG QR code for WhatsApp URL https://wa.me/447860034005?text=payment code q0YR6lzpXJiNo5GMjwXk'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment/qr/png/200/https%3A%2F%2Fwa.me%2F447860034005%3Ftext%3Dpayment%2520code%2520q0YR6lzpXJiNo5GMjwXk' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get QR code in PNG format.

base64 format of QR code

echo 'Generate 200x200px base64 QR code for WhatsApp URL https://wa.me/447860034005?text=payment code q0YR6lzpXJiNo5GMjwXk'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment/BJgJVrqEnQIpYpQpLxrY/qr/base64/200' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get base64 format of QR code PNG image.

"png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAklEQVR4AewaftIAAAs2SURBVO3BQY4kx7IgQdVA3f/KOr1xwBdjQCArm4/8MBH7g7XW/9fDWmv0sNYaPay1Rg9rrdHDWmv0sNYaPay1Rg9rrdHDWmv0sNYaPay1Rg9rrdHDWmv0sNYa/fALKn9TxU3lExWHyq3iULlVHCqTipvKGxU3laPipnJU3FSOionKWxWHylsVE5Wj4qbyN1V84mGtNXpYa41++JKKb1B5o2KiclM5Kj5RMVG5VUxUDpVbxaFyqzhUJipvVXyi4lC5qfxWxTeo/NbDWmv0sNYaPay1Rj/8JSpvVHxC5RMqk4qbylFxU5moHBXfVvEJlZvKUXFTOSreqjhUvkHljYpve1hrjR7WWqMf/kMqJiq/pTJR+baKm8pE5ai4qUwqjoqJyq1ionJUvFXxX/Ow1ho9rLVGD2ut0Q//USrfUDFReaPipvKGyjdUTFR+S+UTFf91D2ut0cNaa/TDX1LxbSqTikNlUnFTeaPipnKofKLiLZVD5VbxiYo3Km4qh8qk4hsq/lce1lqjh7XW6GGtNfrhS1T+SRU3laPipvJGxU3ljYqbyidUjopJxU3lqJhU3FSOipvKUTGpuKlMVI6Kicq/xcNaa/Sw1hrZH/xHqEwq3lCZVExUbhWHyicq3lKZVBwqn6i4qXyi4lCZVPwXPKy1Rg9rrdHDWmtkf/AXqLxRcVM5Km4qb1RMVD5R8QmVb6u4qXyi4lCZVNxUjoqbylExUXmrYqLyRsUnHtZao4e11sj+4H9I5VbxWypvVUxUJhWHyjdUHCqfqJio/G0Vh8qtYqJyVExUJhU3laPiEw9rrdHDWmv0sNYa/fAlKm9VTFSOipvK36RyqzhUPlHxbRU3lTcqvkHlt1QmKp9Q+baHtdboYa01+uEvqXij4q2Kicqk4lB5S2WiMqmYqEwqPlFxqHxDxRsVN5VPVBwqt4o3VL7tYa01elhrjR7WWqMffkHlqJiofEPFoXKr+ITKUXFTOSpuKkfFTeWouFV8omKiclRMVG4Vh8pE5VbxCZWJym9VfNvDWmv0sNYa/fALFYfKpOKmclR8g8obFROVicqt4lB5S2VS8Vsq31bxDRWHyqTipnJU3FTeqPjEw1pr9LDWGj2stUY/fEnFJ1QmFZOKT6jcKiYVE5VPVBwqb6m8UXFT+ZtUbhWHyk3lDZWJyj/pYa01elhrjewPPqQyqThU3qr4hMqk4lD5RMVEZVJxU3mj4hMqn6i4qfxNFTeVScVEZVLxWw9rrdHDWmv0sNYa2R98SGVSMVE5Km4qR8VE5RMVn1B5q+INlU9U3FSOionKJypuKkfFTeWomKh8Q8Whcqv4rYe11uhhrTWyP/gClVvFoXKrOFRuFYfKreLbVI6Kicqt4lCZVNxUjoqJyq3i21SOipvKpOJQeatiovI3VXziYa01elhrjR7WWiP7gw+pHBU3lUnFofJWxaHyVsWh8lbFROWo+ITKreITKm9U3FQmFX+TyjdUTFSOik88rLVGD2ut0Q9fonKreKNiojKpuKkcFZ+o+AaVScUbKreKQ+XbKm4qR8VN5RMVR8VN5Y2Kicqt4rce1lqjh7XW6GGtNfrhL1GZVExUfkvlVjGpmKgcFd+g8kbFTWVS8Vsqb1UcKpOKb6iYqPxND2ut0cNaa/TDl1TcVCYqk4o3VG4VE5WJylExUflExURlonKrOFRuKkfFTWVS8QmVo+ITKpOKicqt4m96WGuNHtZao4e11sj+4EMqR8VE5dsqbiqTikPlVnGo3CoOlbcqJiq/VXFTeaPipvKJionKUXFT+baKQ2VS8YmHtdboYa01sj/4ApVbxUTlqHhL5W+qmKhMKm4qb1S8pXJUfELlVnGofEPFROWoeEtlUvE3Pay1Rg9rrdHDWmv0w7+MylHxVsVEZVJxqEwqJiq3ionKROWo+ITKreKomFRMVG4Vh8pE5S2Vo2JScVOZVPzWw1pr9LDWGv3wl6h8ouKNionKpOKm8gmViconKn6r4qYyqfitim+o+DaVo+ITD2ut0cNaa/Sw1hr98A+ouKkcKp9QeatiUjFRmVQcKreKicqh8g0qR8Wk4p9UcVM5VD6hcquYqPzWw1pr9LDWGtkffEjlExVvqEwqbiq/VXFTmVRMVN6ouKkcFZ9QuVW8oTKpmKi8VXGo3CoOlVvFoXKrOFQmFZ94WGuNHtZao4e11uiHX6h4Q+Wm8m9RcahMKt6qOFRuFYfKreJQuVV8QuUTFYfKWxWHylsqR8WkYlJxU/mth7XW6GGtNbI/+JDKb1W8pfKJik+oHBWfUPlExU1lUjFROSpuKkfFTWVS8YbKWxWHyrdVfOJhrTV6WGuNHtZaI/uDv0DlqLipfKLi21SOionKreJQmVRMVG4V36byRsVEZVLxlspRcVM5Km4qR8U/6WGtNXpYa41++AWVScWh8lbFROW3Km4Vh8q3qXxC5RsqPqFyVNxUDpVbxaHyCZV/i4e11uhhrTV6WGuNfviFikPlpnJUTFRuKkfFJypuKofKv0XFpGKiMqmYqLxVcajcKr6t4g2VW8VE5aj4xMNaa/Sw1hr98AsqR8VN5VC5VUwqPlFxqEwqbipHxU3lqLipHBU3lUnFoXKrmKgcFZ+ouKm8UfGWyqTiULlVHCqfUPm2h7XW6GGtNXpYa43sD/6HVD5R8Q0qn6g4VG4Vn1A5Km4qf1PFROVW8Vsqn6i4qRwVN5Wj4hMPa63Rw1prZH/wIZU3KiYqt4qJyqTiUPlExU3ljYqbylHxCZVbxURlUnGo3ComKr9VMVGZVNxUfqviEw9rrdHDWmv0sNYa2R98gcpbFROVo+ItlUnFROWomKhMKt5SOSpuKkfFTWVS8Vsqk4qbyqTiULlVHCq3in+jh7XW6GGtNbI/+JDKt1VMVCYVn1D5rYqJyqRiojKp+ITKrWKiclRMVCYVb6kcFTeVScVE5aj4xMNaa/Sw1ho9rLVGP/xCxaFyq3hD5abyRsVN5RMVh8qk4i2V36q4qRwqt4qJylExUblVHCpvVRwq31Dxv/Kw1ho9rLVGP/wlKpOKo2Kicqv4NpVPqHyi4rcqPqFyq/itiknFWyqHylsVh8q3Pay1Rg9rrdHDWmtkf/AhlTcq3lI5Km4qR8VN5Y2Km8pRMVG5VUxU/kkV/ysqt4pD5dsqJiq3it96WGuNHtZaI/uD/wiVo+Km8kbFWypHxTeoHBVvqbxRcVM5Km4qk4pDZVLxlspR8ZbKUfFPelhrjR7WWqOHtdboh19Q+ZsqbhWTik+oHBUTlUnFTeWoeEvlqJhUTFRuFYfKreITFYfKreITKkfFROVWMVE5Kj7xsNYaPay1Rj98ScU3qHxC5Y2KtyreUPmGit+q+AaVo+KmMlH5RMUbFROVb3tYa40e1lqjh7XW6Ie/ROWNirdU3qi4qRwqt4pD5VZxqHxCZaLyCZVJxVsqR8Wt4lD5NpVvUPmbHtZao4e11uiH/4NUbhWHyqRiUvGWyicq3lB5S+WfVHGo3ComKpOKQ+VWMVH5rYe11uhhrTV6WGuNfvg/ouJQuakcFROVtyoOlbcqDpWbyqTiExUTlUNlUjFRuakcFTeV36r4Jz2stUYPa63RD39JxbdVHCqTipvKoXKreKPirYpD5aZyVNxUfkvlrYqJykTlqLipHCpvVbyhMqn4toe11uhhrTV6WGuNfvgSlX9SxUTlVnGoTCpuKhOVo2JSMVGZVNxUjoqbyhsVE5WJyq3ijYqbykTlqLipHBU3lUPl2x7WWqOHtdbI/mCt9f/1sNYaPay1Rg9rrdHDWmv0sNYaPay1Rg9rrdHDWmv0sNYaPay1Rg9rrdHDWmv0sNYa/T+67UwBCRKuIQAAAABJRU5ErkJggg=="

Generate QR Code for Payment Request Unique Code

You can encode Payment Request Unique Code as QR code.

Use endpoint GET /v1/apps/payment/:payment_requst_unique_code/qr/:format/:width to get image of QR code form Orangepill platform.

Supported formats are png and base64.

Use parameter width to define the size of QR code.

PNG format of QR Code

echo 'Generate 200x200px PNG QR code for Payment Request Code BJgJVrqEnQIpYpQpLxrY'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment/BJgJVrqEnQIpYpQpLxrY/qr/png/200' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get QR code in PNG format.

base64 format of QR code

echo 'Generate 200x200px base64 QR code for Payment Request Code BJgJVrqEnQIpYpQpLxrY'

curl --location --request GET 'https://api.orangepill.cloud/v1/apps/payment/BJgJVrqEnQIpYpQpLxrY/qr/base64/200' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json'

In response we get base64 format of QR code PNG image.

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAklEQVR4AewaftIAAAXiSURBVO3BUW4j0REEwawG73/l9H4/TwMDDElJdkXEf6iqS0NVrYaqWg1VtRqqajVU1WqoqtVQVauhqlZDVa2GqloNVbUaqmo1VNVqqKrVUFWroapWQ1WthqpaDVW1GqpqNVTV6sWHJOE3UrkrCXep3JGET1A5JeEulbuS8BupvNtQVauhqlZDVa2GqloNVbV68WUq35KEO5Jwl8oTKncl4QmVK0l4N5VvScK3DFW1GqpqNVTVaqiq1YtfIAlPqHyCyrsl4S6VK0k4JeGkckXlW5LwhMpPGqpqNVTVaqiq1VBVqxf1MUk4qVxJwikJV1ROSTgl4S6V+m9DVa2GqloNVbUaqmo1VNXqRa2S8ITKXSrvpnIlCXXPUFWroapWQ1WthqpavfgFVH4jlbuScErCt6jcpXJKwhWVJ1T+sqGqVkNVrYaqWg1VtRqqavXiy5LwlyXhisopCSeVK0k4qVxJwh1JuKLybkn4XzRU1WqoqtVQVauhqlYvPkTlr1C5koSTypUknFTuUvlJKnep/L8Yqmo1VNVqqKrVUFWr+A8/LAknlbuS8AkqpyRcUbkjCVdUTkn4FpUrSTipnJLwLSrfMlTVaqiq1VBVq6GqVkNVrV58WRJOKqck3KXyCUk4qVxJwhNJeELllIQrKk8k4S6Vv2yoqtVQVauhqlZDVa1e/DEqdyXhpHJKwhWVUxKuqJyScJfKXUl4IgknlU9IwhMqpyRcUXm3oapWQ1WthqpaDVW1Gqpq9eLLVO5QuZKEu1ROSTipfILKE0m4KwknladUTkk4qVxJwl0qv81QVauhqlZDVa2Gqlq9+LIkPKFySsKVJJxUnlC5koSTyl1JOKnclYS7knBS+QSVu5Lw2wxVtRqqajVU1WqoqtWLD0nCXSqfoHJHEq6o3KVyRxKuqJyS8EQSrqickvBEEq6o/GVDVa2GqloNVbUaqmo1VNXqxYeoXEnCKQknlStJOKlcScJJ5a4knFR+msopCXcl4Scl4YrKHUn4lqGqVkNVrYaqWg1VtXrxIUm4onJKwl0qd6mckvAJSTipnFS+ReVKEu5SOSXhW5JwUvmWoapWQ1WthqpaDVW1Gqpq9eJDVO5SOSXhisopCU+o3JWEKyp3JOGnqZyS8ITK/6KhqlZDVa2GqloNVbWK//BFSTipPJGEKyo/KQl3qZyScEXl3ZJwl8opCVdU/rKhqlZDVa2GqloNVbWK//ABSXhC5UoS3k3lE5JwUrmShJPKlSScVE5JuKJySsK3qFxJwknllIQrKu82VNVqqKrVUFWroapWQ1Wt4j/8Qkm4onJKwhWVO5JwReXdknCXypUk/CSVUxKeUvlthqpaDVW1GqpqNVTVKv7DByThLpVTEj5B5YkkPKHyLUm4onJKwreoPJGEKyrvNlTVaqiq1VBVq6GqVkNVrV58iMoTKt+ShCsqT6icknBF5ZSEJ1SeUnkiCackXFE5JeGk8i1DVa2GqloNVbUaqmr14kOS8BupfEsSnlC5koSTyrck4aRyl8pdKqckXFF5t6GqVkNVrYaqWg1VtXrxZSrfkoSfpHJKwpUknFQ+IQlPqDyRhCsqd6h8y1BVq6GqVkNVrYaqWg1VtXrxCyThCZUnVK4k4d1UriThlIQrKqcknFSeSsK3JOEJlXcbqmo1VNVqqKrVUFWrF7VSOSXhisodSXgqCSeVUxLuUrmShJPKKQlXVJ5IwknlW4aqWg1VtRqqajVU1WqoqtWLIgmfkISTypUknFSuJOGUhLtUTkm4KwknlStJeLckXFF5t6GqVkNVrYaqWg1VtXrxC6j8JJUrSTipXEnCX6ZyVxI+QeW3GapqNVTVaqiq1VBVqxdfloS/QuUJlbtUTkl4QuVKEu5SuSMJV1ROSbiShJPKKQlXVN5tqKrVUFWroapWQ1WthqpaxX+oqktDVa2GqloNVbUaqmo1VNVqqKrVUFWroapWQ1WthqpaDVW1GqpqNVTVaqiq1VBVq6GqVkNVrYaqWg1VtRqqavUfaQVIm0GP+0MAAAAASUVORK5CYII="

Reveal QR Code

You can use Orangepill API to reveal the image of QR code and decode the Payment Request Unique Code.

You must provide QR code in base64 format.

echo 'Reveal Payment Request Unique Code from QR image'

curl --location --request POST 'https://api.orangepill.cloud/v1/apps/payment/qr/reveal' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'Content-Type: application/json' \
--data-raw '{
	"base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAklEQVR4AewaftIAAAXiSURBVO3BUW4j0REEwawG73/l9H4/TwMDDElJdkXEf6iqS0NVrYaqWg1VtRqqajVU1WqoqtVQVauhqlZDVa2GqloNVbUaqmo1VNVqqKrVUFWroapWQ1WthqpaDVW1GqpqNVTV6sWHJOE3UrkrCXep3JGET1A5JeEulbuS8BupvNtQVauhqlZDVa2GqloNVbV68WUq35KEO5Jwl8oTKncl4QmVK0l4N5VvScK3DFW1GqpqNVTVaqiq1YtfIAlPqHyCyrsl4S6VK0k4JeGkckXlW5LwhMpPGqpqNVTVaqiq1VBVqxf1MUk4qVxJwikJV1ROSTgl4S6V+m9DVa2GqloNVbUaqmo1VNXqRa2S8ITKXSrvpnIlCXXPUFWroapWQ1WthqpavfgFVH4jlbuScErCt6jcpXJKwhWVJ1T+sqGqVkNVrYaqWg1VtRqqavXiy5LwlyXhisopCSeVK0k4qVxJwh1JuKLybkn4XzRU1WqoqtVQVauhqlYvPkTlr1C5koSTypUknFTuUvlJKnep/L8Yqmo1VNVqqKrVUFWr+A8/LAknlbuS8AkqpyRcUbkjCVdUTkn4FpUrSTipnJLwLSrfMlTVaqiq1VBVq6GqVkNVrV58WRJOKqck3KXyCUk4qVxJwhNJeELllIQrKk8k4S6Vv2yoqtVQVauhqlZDVa1e/DEqdyXhpHJKwhWVUxKuqJyScJfKXUl4IgknlU9IwhMqpyRcUXm3oapWQ1WthqpaDVW1Gqpq9eLLVO5QuZKEu1ROSTipfILKE0m4KwknladUTkk4qVxJwl0qv81QVauhqlZDVa2Gqlq9+LIkPKFySsKVJJxUnlC5koSTyl1JOKnclYS7knBS+QSVu5Lw2wxVtRqqajVU1WqoqtWLD0nCXSqfoHJHEq6o3KVyRxKuqJyS8EQSrqickvBEEq6o/GVDVa2GqloNVbUaqmo1VNXqxYeoXEnCKQknlStJOKlcScJJ5a4knFR+msopCXcl4Scl4YrKHUn4lqGqVkNVrYaqWg1VtXrxIUm4onJKwl0qd6mckvAJSTipnFS+ReVKEu5SOSXhW5JwUvmWoapWQ1WthqpaDVW1Gqpq9eJDVO5SOSXhisopCU+o3JWEKyp3JOGnqZyS8ITK/6KhqlZDVa2GqloNVbWK//BFSTipPJGEKyo/KQl3qZyScEXl3ZJwl8opCVdU/rKhqlZDVa2GqloNVbWK//ABSXhC5UoS3k3lE5JwUrmShJPKlSScVE5JuKJySsK3qFxJwknllIQrKu82VNVqqKrVUFWroapWQ1Wt4j/8Qkm4onJKwhWVO5JwReXdknCXypUk/CSVUxKeUvlthqpaDVW1GqpqNVTVKv7DByThLpVTEj5B5YkkPKHyLUm4onJKwreoPJGEKyrvNlTVaqiq1VBVq6GqVkNVrV58iMoTKt+ShCsqT6icknBF5ZSEJ1SeUnkiCackXFE5JeGk8i1DVa2GqloNVbUaqmr14kOS8BupfEsSnlC5koSTyrck4aRyl8pdKqckXFF5t6GqVkNVrYaqWg1VtXrxZSrfkoSfpHJKwpUknFQ+IQlPqDyRhCsqd6h8y1BVq6GqVkNVrYaqWg1VtXrxCyThCZUnVK4k4d1UriThlIQrKqcknFSeSsK3JOEJlXcbqmo1VNVqqKrVUFWrF7VSOSXhisodSXgqCSeVUxLuUrmShJPKKQlXVJ5IwknlW4aqWg1VtRqqajVU1WqoqtWLIgmfkISTypUknFSuJOGUhLtUTkm4KwknlStJeLckXFF5t6GqVkNVrYaqWg1VtXrxC6j8JJUrSTipXEnCX6ZyVxI+QeW3GapqNVTVaqiq1VBVqxdfloS/QuUJlbtUTkl4QuVKEu5SuSMJV1ROSbiShJPKKQlXVN5tqKrVUFWroapWQ1WthqpaxX+oqktDVa2GqloNVbUaqmo1VNVqqKrVUFWroapWQ1WthqpaDVW1GqpqNVTVaqiq1VBVq6GqVkNVrYaqWg1VtRqqavUfaQVIm0GP+0MAAAAASUVORK5CYII="
}'

In response we get Payment Request Unique Code.

"BJgJVrqEnQIpYpQpLxrY"

Make payment

To make payment and change status of the Payment Request, you must create transaction of type payment and reference Payment Request in related object.

Transaction can be in any currency. After the transaction is processed, amount in transaction asset is calculated and compared to amount in Payment Request currency. If transaction amount is equal or greater than the amount of Payment Request, status will be changed to DONE. If amount of transaction is less then amount in Payment Request, status will be changed to INCOMPLETE.

After the Payment Request status is changed, Orangepill core will call callback URL.

echo 'Pay with transaction'

curl --location --request POST 'https://api.orangepill.cloud/v1/transaction' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933dffabb' \
--header 'Content-Type: application/json' \
--data-raw '{
"source": {
    "account": "6695b47a6b1b76f77fc2116a"
},
"destination": {
	"alias": "@merchantalias"
},
"type": "payment",
"value": 5000,
"asset": "YOUR_POINTS",
"related": [{
    "type": "apps.payment",
    "value": "BJgJVrqEnQIpYpQpLxrY"
}],
"description": "Cart from WooCommerce",
"data": {}
}'

In response we get new Transaction object.

{
    "id": "6698da2675e2ef1c0a7b18c7",
    "source": {
        "account": "6695b47a6b1b76f77fc2116a",
        "owner": "65c395e9765ee9ee257bd765",
        "holder": "6695b47974444801383847a2"
    },
    "destination": {
        "account": "6667c8baddbdb1bfe0b3e312",
        "alias": "LUISA_POSTRES_YOUR_POINTS",
        "owner": "65c395e9765ee9ee257bd765",
        "holder": "6667c87d3e551062b39dafb1"
    },
    "value": "5000",
    "asset": "YOUR_POINTS",
    "data": {},
    "type": "payment",
    "related": [
        {
            "type": "apps.payment",
            "value": "BJgJVrqEnQIpYpQpLxrY",
            "created_at": 1721141056486
        }
    ],
    "holder": "65c395e9765ee9ee257bd766",
    "owner": "65c395e9765ee9ee257bd765",
    "created_at": 1721293350429,
    "external": [],
    "status": "PROCESSING",
    "error": null,
    "amount": "5000"
}

PreviousPayment Request NextForwarding Transactions

Last updated 1 year ago

hashtagVersion 1.0

hashtagStatic Payment Requests

hashtagDynamic Payment Requests

hashtagDirect Payment Requests

hashtagCreate Payment Request v1.0

hashtagGet Payment Request details

hashtagDelete Payment Request

hashtagList Payment Requests

hashtagGenerate QR Code for URL

hashtagPNG format of QR Code

hashtagbase64 format of QR code

hashtagGenerate QR Code for Payment Request Unique Code

hashtagPNG format of QR Code

hashtagbase64 format of QR code

hashtagReveal QR Code

hashtagMake payment

Version 1.0

Static Payment Requests

Dynamic Payment Requests

Direct Payment Requests

Create Payment Request v1.0

Get Payment Request details

Delete Payment Request

List Payment Requests

Generate QR Code for URL

PNG format of QR Code

base64 format of QR code

Generate QR Code for Payment Request Unique Code

PNG format of QR Code

base64 format of QR code

Reveal QR Code

Make payment