Payment Requests
Payment Requests represent the intention for a merchant to receive payment for goods and services. Payment Requests define the amount to be paid and the asset types that are acceptable for payment.
A Payment Request is shared with, and paid by, a patron. The Payment Flows Guide has more details regarding negotiation of Payment Requests.
Payment Requests have the following statuses:
- new: after being created.
- paid: after being paid with one or more transactions.
- cancelled: after being cancelled or voided by the merchant.
- expired: after expiry time is reached without being paid or cancelled.
- refunded: after being partially or fully refunded.
Payment requests can also be refunded for a short period of time after being paid.
Payment request state transitions can be notified to webhooks.
Centrapay Payment Requests are serviced via two sets of endpoints; the “next” version (documented on this page) and the “legacy” version (documented at Legacy Payment Requests).
Contents
Models
Payment Request
Mandatory Fields
Field | Type | Description |
---|---|---|
id | String | The payment request id. |
value | Monetary | The canonical value of the payment request. Must be positive. |
paymentOptions | Array | The Payment Options, indicating valid asset for payment. |
merchantId | String | The id of the Merchant the Payment Request is on behalf of. |
merchantName | String | The name of the Merchant the Payment Request is on behalf of. |
configId | String | The Merchant Config id used to configure the payment options. |
status | String | “new”, “paid”, “cancelled”, “expired”, “refunded”. |
liveness | String | Indicates liveness of assets that are accepted, determined by the payment options. Values are “main” or “test”. |
createdAt | Timestamp | When the payment request was created. |
updatedAt | Timestamp | When the payment request was updated. |
expiresAt | Timestamp | When the payment request expires. |
merchantConditions | Array | The Merchant Conditions that require operator approval to complete a payment. |
Optional Fields
Field | Type | Description |
---|---|---|
patronCodeId | String | The id of a Patron Code the payment request is attached to. |
barcode | String | Scanned patron barcode used to create the payment request. |
expirySeconds | Number | The expiry seconds used to configure the payment request expiry. |
lineItems | Array | EXPERIMENTAL The Line Items being paid for. |
purchaseOrderRef | String | A reference to a purchase order for this payment request. |
invoiceRef | String | A reference to an invoice for this payment request. |
redirectUrl | String | Experimental URL to redirect the user to after they pay or cancel the Payment Request. Must start with one of the allowedRedirectUrls for the Merchant Config. |
externalRef | String | An external reference to the payment request |
terminalId | String | The software or logical id of the payment terminal. |
deviceId | String | The hardware id or serial number of the payment terminal. |
operatorId | String | POS operator Id. |
createdByAccountId | String | Id of the Centrapay Account creating the Payment Request. |
createdByAccountName | String | Name of the Centrapay Account creating the Payment Request. |
conditionsEnabled | Boolean | Flag to opt into accepting Asset Types which require conditions to be met. If not set, assets which require conditions will not be payment options. |
patronNotPresent | Boolean | Flag to indicate the patron is not physically present. This may affect payment conditions or available Payment Options. |
cancellationReason | String | The reason that the payment request was cancelled. See Cancellation Reasons for possible values. |
Payment Option
Mandatory Fields
Field | Type | Description |
---|---|---|
assetType | String | An Asset Type reference. |
amount | BigNumber | The value required to pay using the canonical units for the asset type. |
Optional Fields
Field | Type | Description |
---|---|---|
bitcoinAddress | String | ★ Address to send Bitcoin, when the “assetType” is bitcoin.* |
cennzAddress | String | ★ Address to send CPay, when the “assetType” is cennznet.* |
wavesAddress | String | ★ Waves address to send Zap tokens, when the “assetType” is zap.* |
productCodes | Array | Supported product codes for the payment request, when the “assetType” is epay.nzd.* |
★ For payment options which specify an address, there’s a requirement to make a transaction on an external ledger. Once you have made that payment, you can use the transaction id to Pay a Payment Request using the legacy payment API.
Merchant Condition
Some asset types may require conditional operator approval. Requires conditionsEnabled
to be set to true or the asset type may not be a Payment Option.
Conditions always require a yes/no answer from the terminal operator. Possible merchant conditions include, among others, confirming proof of ID or confirming a promotional item was purchased. Conditions must be approved for a Payment Request to be paid
with the asset type.
Fields
Name | Type | Description |
---|---|---|
id | BigNumber | An enumerated identifier for the Merchant Condition. |
name | String | The name of the condition. |
message | String | The message that can be displayed to the merchant. |
status | String | The status of the condition. Valid values include accepted , declined , awaiting-merchant or void . |
Line Item
An order item for which payment is requested. The currency and units for a line item price will be consistent with the payment request value and the sum of line item prices should equal the payment request value.
Line items can include a discount amount. A discount that applies to multiple line items may be represented as a separate line item with a negative amount.
Mandatory Fields
Field | Type | Description |
---|---|---|
name | String | The product description. |
sku | String | The product (stock keeping unit) code. |
qty | BigNumber | The product quantity (eg. item count, weight, volume etc). |
price | BigNumber | The final price in cents (eg. product price * qty - discounts + tax). |
Optional Fields
Field | Type | Description |
---|---|---|
tax | BigNumber | Tax rate (percentage). |
discount | BigNumber | Discount amount in cents (tax exclusive). |
productId | String | Manufacturer’s product identifier (eg GTIN/EAN). |
restricted | Boolean | Disallow payment with a “restricted” Asset Type. |
classification | Object | Product Classification. |
Product Classification
Mandatory Fields
Field | Type | Description |
---|---|---|
type | String | The classification type (see below). |
code | String | The classification code. |
name | String | The classification description. |
Optional Fields
Field | Type | Description |
---|---|---|
props | Map | The product classification properties (see below). |
Classification Types
Currently only “GS1” is supported. See GS1 Global Product Classification. When “GS1” is used as the product classification type then the product code should be the GPC product brick identifier.
Classification Properties
Classification properties allow optional additional product characterizing attrubutes to be supplied. In the case of GS1 product classifications this corresponds to the GPC brick attributes.
Paid By
The Paid By provides a summary of the transactions after the Payment Request was paid.
Mandatory Fields
Field | Type | Description |
---|---|---|
assetTotals | Array | The sum of paid amounts Asset Totals for each transacted asset type. |
Asset Total
Mandatory Fields
Field | Type | Description |
---|---|---|
type | String | The asset type used for the payment. |
description | String | A human readable description of the asset type used. |
settlementDate | Timestamp | The estimated date that the merchant can expect settlement of funds. |
total | Monetary | The total monetary value of the asset type used to pay a Payment Request |
Payment Activity EXPERIMENTAL
A Payment Activity records a transaction that has happened on a Payment Request. Payment Activities are created when a Payment Request has been created, paid, refunded, cancelled, or expired.
Mandatory Fields
Field | Type | Description |
---|---|---|
type | String | See Activity Types below. |
value | Monetary | The value of the payment activity. Must be positive. |
paymentRequestId | String | The Payment Request’s id. |
merchantId | String | The Payment Request’s Merchant id. |
merchantConfigId | String | The Payment Request’s Merchant Config id. |
merchantAccountId | String | The Payment Request’s Merchant Account id. |
merchantName | String | The Payment Request’s Merchant name. |
createdAt | Timestamp | When the activity was created. |
createdBy | CRN | The identity that created the activity. |
paymentRequestCreatedBy | CRN | The identity that created the Payment Request. |
activityNumber | BigNumber | Unique sequential number for the activity. |
Optional Fields
Field | Type | Description |
---|---|---|
assetType | String | The Asset Type for the “payment” or “refund” activity. |
external | Boolean | The payment activity is recording a transaction that occurred outside the Centrapay system. |
cancellationReason | String | The reason that the Payment Request was cancelled. See Cancellation Reasons for possible values. |
Activity Types
Name | Description |
---|---|
request | Payment Request was created. |
payment | Payment Request was paid. |
refund | Funds were returned to the shopper. |
cancellation | Payment Request was cancelled by the merchant or the shopper. |
expiry | Payment Request wasn’t paid before time out. |
Cancellation Reasons
Reason | Description |
---|---|
CANCELLED_BY_MERCHANT | The merchant cancelled the payment request by calling the cancel or void endpoint. |
CANCELLED_BY_PATRON | The patron cancelled the transaction. |
PATRON_CODE_INVALID | The patron code on the payment request was invalid. |
INSUFFICIENT_ASSET_VALUE | The asset has insufficient funds to pay the payment request or the transaction amount received by Centrapay is less than the total of the payment. |
PAYMENT_FAILED | The payment request failed for an unknown reason. |
Operations
Create a Payment Request
POST /
Create a Payment Request
curl -X POST https://service.centrapay.com/api/payment-requests \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"amount": "8991",
"currency": "NZD"
}
}'
Create a Payment Request with redirect url
curl -X POST https://service.centrapay.com/api/payment-requests \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"amount": "8991",
"currency": "NZD"
},
"redirectUrl": "https://example.com/store/checkout?cartId=1234"
}'
Create a Payment Request with a Patron Code
curl -X POST https://service.centrapay.com/api/payment-requests \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"barcode": "1219210961929460",
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"amount": "8991",
"currency": "NZD"
}
}'
Create a Payment Request with purchase order, invoice, and external reference
curl -X POST https://service.centrapay.com/api/payment-requests \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"amount": "8991",
"currency": "NZD"
},
"purchaseOrderRef": "oF6kj1QlH5gK0y9rjRHFh2",
"invoiceRef": "sy8CRmo3sp3ArOpnfmb423",
"externalRef": "dYTC266s4DFdsgGd909f"
}'
Create a Payment Request with Line Items
curl -X POST https://service.centrapay.com/api/payment-requests \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"amount": "6190",
"currency": "NZD"
},
"lineItems": [
{
"name": "Coffee Grounds",
"sku": "GH1234",
"qty": "1",
"price": "4195",
"tax": "15.00"
},
{
"name": "Centrapay Cafe Mug",
"sku": "SB456",
"qty": "25",
"price": "1995",
"tax": "15.00",
"discount": "199",
"restricted": true,
"productId": "19412345123459",
"classification": {
"type": "GS1",
"code": "10001874",
"props": {
"20001479": "30008960"
}
}
}
]
}'
Fields
Field | Type | Description |
---|---|---|
configId | String | The Merchant Config id used to configure the payment options. |
value | Monetary | The canonical value of the payment request. Must be positive. |
barcode | String Optional | The patron’s barcode to identify the account to attach the payment request to |
expirySeconds | String Optional | How long the payment request will be payable for. |
lineItems | Array Optional | Experimental The Line Items being paid for. |
purchaseOrderRef | String Optional | A reference to a purchase order for this payment request. |
invoiceRef | String Optional | A reference to an invoice for this payment request. |
externalRef | String Optional | An external reference to the payment request |
redirectUrl | String Optional | Experimental URL to redirect the user to after they pay or cancel the Payment Request. Must start with one of the allowedRedirectUrls for the Merchant Config. |
terminalId | String Optional | The software or logical id of the payment terminal. |
deviceId | String Optional | The hardware id or serial number of the payment terminal. |
operatorId | String Optional | The POS operator Id. |
createdByAccountId | String Optional | The id of the Centrapay Account creating the Payment Request. |
createdByAccountName | String Optional | The name of the Centrapay Account creating the Payment Request. |
conditionsEnabled | Boolean Optional | Flag to opt into accepting Asset Types which require conditions to be met. If not set, assets which require conditions will not be payment options. |
patronNotPresent | Boolean Optional | Flag to indicate the patron is not physically present. This may affect payment conditions or available Payment Options. |
Example response payload
{
"id": "MhocUmpxxmgdHjr7DgKoKw",
"url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
"patronCodeId": "V17FByEP9gm1shSG6a1Zzx",
"barcode": "9990001234567895",
"merchantId": "26d3Cp3rJmbMHnuNJmks2N",
"merchantName": "Centrapay Café",
"configId": "5efbe2fb96c08357bb2b9242",
"purchaseOrderRef": "oF6kj1QlH5gK0y9rjRHFh2",
"invoiceRef": "sy8CRmo3sp3ArOpnfmb423",
"value": {
"currency": "NZD",
"amount": "6190"
},
"paymentOptions": [
{
"amount": "6190",
"assetType": "centrapay.nzd.test"
},
{
"amount": "6190",
"assetType": "epay.nzd.test",
"productCodes": [
"23403"
]
}
],
"lineItems": [
{
"name": "Coffee Grounds",
"sku": "GH1234",
"qty": "1",
"price": "4195",
"tax": "15.00"
},
{
"name": "Centrapay Cafe Mug",
"sku": "SB456",
"qty": "25",
"price": "1995",
"tax": "15.00",
"discount": "199"
}
],
"merchantConditions": [
{
"id": "1",
"name": "photo-id-check",
"message": "Please check ID",
"status": "awaiting-merchant"
}
],
"status": "new",
"createdAt": "2021-06-08T04:04:27.426Z",
"updatedAt": "2021-06-08T04:04:27.426Z",
"expiresAt": "2021-06-08T04:06:27.426Z",
"liveness": "test",
"expirySeconds": 120
}
Error Responses
Status | Code | Description |
---|---|---|
400 | LINE_ | The sum value of the line items did not equal the value of the payment request. |
403 | REDIRECT_ | The supplied redirectUrl does not start with one of the allowedRedirectUrls on the Merchant Config. |
400 | CHECKSUM_ | Luhn checksum digit doesn’t pass. |
403 | PATRON_ | Patron Code doesn’t exist or has expired. |
403 | NO_ | No payment options match the requested payment parameters. |
Get a Payment Request
GET /
curl https://service.centrapay.com/api/payment-requests/MhocUmpxxmgdHjr7DgKoKw \
-H "Authorization: $jwt"
Example response payload
{
"id": "MhocUmpxxmgdHjr7DgKoKw",
"url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
"patronCodeId": "V17FByEP9gm1shSG6a1Zzx",
"barcode": "9990001234567895",
"merchantId": "26d3Cp3rJmbMHnuNJmks2N",
"merchantName": "Centrapay Café",
"configId": "5efbe2fb96c08357bb2b9242",
"purchaseOrderRef": "oF6kj1QlH5gK0y9rjRHFh2",
"invoiceRef": "sy8CRmo3sp3ArOpnfmb423",
"value": {
"currency": "NZD",
"amount": "8991"
},
"paymentOptions": [
{
"amount": "8991",
"assetType": "centrapay.nzd.test"
}
],
"lineItems": [
{
"name": "Coffee Grounds",
"sku": "GH1234",
"qty": "1",
"price": "4195",
"tax": "15.00"
},
{
"name": "Centrapay Cafe Mug",
"sku": "SB456",
"qty": "25",
"price": "1995",
"tax": "15.00",
"discount": "199"
}
],
"merchantConditions": [
],
"status": "new",
"createdAt": "2021-06-08T04:04:27.426Z",
"updatedAt": "2021-06-08T04:04:27.426Z",
"expiresAt": "2021-06-08T04:06:27.426Z",
"liveness": "test",
"expirySeconds": 120
}
Example response payload paid by multiple asset types
{
"id": "MhocUmpxxmgdHjr7DgKoKw",
"url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
"merchantId": "26d3Cp3rJmbMHnuNJmks2N",
"merchantName": "Centrapay Café",
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"currency": "NZD",
"amount": "1000"
},
"paymentOptions": [
{
"amount": "1000",
"assetType": "centrapay.nzd.main"
},
{
"amount": "1000",
"assetType": "cca.coke.main"
}
],
"merchantConditions": [
],
"status": "paid",
"createdAt": "2021-06-08T04:04:27.426Z",
"updatedAt": "2021-06-08T04:04:27.426Z",
"expiresAt": "2021-06-08T04:06:27.426Z",
"liveness": "main",
"expirySeconds": 120,
"paidBy": {
"assetTotals": [
{
"type": "centrapay.nzd.main",
"description": "Centrapay NZD",
"settlementDate": "2021-06-28T04:04:27.426Z",
"total": {
"amount": "550",
"currency": "NZD"
}
},
{
"type": "cca.coke.main",
"description": "Coke Token",
"settlementDate": "2021-06-28T04:04:27.426Z",
"total": {
"amount": "450",
"currency": "NZD"
}
}
]
}
}
Get a Payment Request linked to a Patron Code
Returns the latest Payment Request with status “new” that has been attached to a Patron Code. The Payment Request may have been created with a reference to any Patron Code owned by the user’s account.
This endpoint should be polled just after a user’s Patron Code has been scanned. This will allow them to find the Payment Request and proceed to pay.
GET /
curl https://service.centrapay.com/api/me/patron-code-payment-request \
-H "Authorization: $jwt"
Example response payload when no new Payment Request found
{
}
Example response payload with a Payment Request
{
"id": "MhocUmpxxmgdHjr7DgKoKw",
"url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
"patronCodeId": "V17FByEP9gm1shSG6a1Zzx",
"barcode": "9990001234567895",
"merchantId": "26d3Cp3rJmbMHnuNJmks2N",
"merchantName": "Centrapay Café",
"configId": "5efbe2fb96c08357bb2b9242",
"value": {
"currency": "NZD",
"amount": "100"
},
"paymentOptions": [
{
"amount": "100",
"assetType": "centrapay.nzd.test"
}
],
"merchantConditions": [
],
"status": "new",
"createdAt": "2021-06-08T04:04:27.426Z",
"updatedAt": "2021-06-08T04:04:27.426Z",
"expiresAt": "2021-06-08T04:06:27.426Z",
"liveness": "test",
"expirySeconds": 120
}
Pay a Payment Request EXPERIMENTAL
There are two methods of paying a payment request. The first uses Centrapay Assets and requires you to provide the Id and the type of the asset. Alternatively you can provide an external transaction Id and the Centrapay Asset Type for any payments that we support. An example of an external transaction would be a Bitcoin payment.
POST /
Pay a Payment Request with a Centrapay asset
curl -X POST https://service.centrapay.com/api/payment-requests/{paymentRequestId}/pay \
-H "Authorization: $jwt" \
-H "Content-Type: application/json" \
-d '{
"assetType": "centrapay.nzd.main",
"assetId": "WRhAxxWpTKb5U7pXyxQjjY"
}'
Pay a Payment Request using external transaction
curl -X POST https://service.centrapay.com/api/payment-requests/{paymentRequestId}/pay \
-H "Authorization: $jwt" \
-H "Content-Type: application/json" \
-d '{
"assetType": "bitcoin.main",
"transactionId": "VMXMkUttDGTVz4ESv5ND56"
}'
Example response payload
{
"type": "payment",
"value": {
"currency": "NZD",
"amount": "1000"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "26d3Cp3rJmbMHnuNJmks2N",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5efbe2fb96c08357bb2b9242",
"createdAt": "2021-06-08T04:04:27.426Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "2"
}
Error Responses
Status | Code | Description |
---|---|---|
403 | INVALID_ | Either the merchant is not configured with the provided asset type or the asset type does not exist. |
403 | REQUEST_ | Action cannot be completed because the request has expired. |
403 | REQUEST_ | Action cannot be completed because the request has been paid. |
403 | REQUEST_ | Action cannot be completed because the request has already been cancelled. |
403 | INACTIVE_ | The asset is not spendable. It may have been disabled, expired, or already spent. |
403 | INVALID_ | The merchant is not configured properly to satisfy the payment request. This could be due to incorrect information, or the merchant’s credentials might be blocked by an external service. |
403 | QUOTA_ | The payment pay request exceeds the allowed spend quota supplied. |
403 | INSUFFICIENT_ | The asset has insufficient funds to pay the payment request or the transaction amount received by Centrapay is less than the total of the payment. |
403 | ASSET_ | The asset redemption has been unsuccessful due to an error with provided payment parameters, the merchant, or the asset. |
403 | PAYMENT_ | The payment parameters were valid but payment was declined because additional payment restrictions were violated. |
Refund a Payment Request EXPERIMENTAL
POST /
Refund a Payment Request
curl -X POST https://service.centrapay.com/api/payment-requests/{paymentRequestId}/refund \
-H "Authorization: $jwt" \
-H "Content-Type: application/json" \
-d '{
"value": {
"amount": "100",
"currency": "NZD"
},
"externalRef": "e8df06e2-13a5-48b4-b670-3fd6d815fe0a"
}'
Example response payload
{
"type": "refund",
"value": {
"currency": "NZD",
"amount": "100"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:17:00.000Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "3"
}
Error Responses
Status | Code | Description |
---|---|---|
403 | NOT_ | The payment request has not been paid. |
403 | ALREADY_ | The payment request has already been refunded. |
403 | INVALID_ | The refund requested is greater than the refundable amount. |
403 | REPEAT_ | A separate refund request for the payment request has the same external reference. Attempting to refund the payment request twice with the same external reference is not allowed. If the amount of the refund is the same we assume it is a repeat request and return 200. |
403 | PARTIAL_ | The asset does not support partial refunds. |
403 | INACTIVE_ | The asset is not refundable. It may have been disabled, expired, or already refunded. |
403 | REFUND_ | The asset type does not support refunds. |
403 | REFUND_ | The time since the payment exceeds the window of time a payment request can be refunded in. |
List Payment Activities For Merchant EXPERIMENTAL
List payment activities for a merchant. Results are paginated and ordered by descending activity created date.
GET /
curl -G https://service.centrapay.com/api/payment-activities \
-H "Authorization: $jwt" \
-d merchantId=5ee0c486308f590260d9a07f \
-d pageKey=PaymentRequest#E9eXsErwA444qFDoZt5iLA|Activity#000000000000001|614161c4c4d3020073bd4ce8|2021-09-15T03:00:21.156Z
Required Fields
Field | Type | Description |
---|---|---|
merchantId | String | The id of the Merchant the Payment Request is on behalf of. |
Optional Fields
Field | Type | Description |
---|---|---|
pageKey | String | Used to retrieve the next page of items. |
Example response payload
{
"nextPageKey": "PaymentRequest#E9eXsErwA444qFDoZt5iLA|Activity#000000000000001|614161c4c4d3020073bd4ce8|2021-09-15T03:00:21.156Z",
"items": [
{
"type": "refund",
"value": {
"currency": "NZD",
"amount": "600"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:17:00.000Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "3"
},
{
"type": "payment",
"value": {
"currency": "NZD",
"amount": "6190"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:16:00.000Z",
"createdBy": "crn::user:da75ad90-9a5b-4df0-8374-f48b3a8fbfcc",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "2"
},
{
"type": "request",
"value": {
"currency": "NZD",
"amount": "6190"
},
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:15:46.000Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "1"
}
]
}
List Payment Activities For Payment Request EXPERIMENTAL
List payment activities for a payment request. Results are ordered by descending activity created date.
GET /
curl https://service.centrapay.com/api/payment-requests/MhocUmpxxmgdHjr7DgKoKw/activities \
-H "Authorization: $jwt"
Example response payload
{
"items": [
{
"type": "refund",
"value": {
"currency": "NZD",
"amount": "600"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:17:00.000Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "3"
},
{
"type": "payment",
"value": {
"currency": "NZD",
"amount": "6190"
},
"assetType": "centrapay.nzd.main",
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:16:00.000Z",
"createdBy": "crn::user:da75ad90-9a5b-4df0-8374-f48b3a8fbfcc",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "2"
},
{
"type": "request",
"value": {
"currency": "NZD",
"amount": "6190"
},
"paymentRequestId": "MhocUmpxxmgdHjr7DgKoKw",
"merchantName": "Centrapay Café",
"merchantId": "5ee0c486308f590260d9a07f",
"merchantAccountId": "C4QnjXvj8At6SMsEN4LRi9",
"merchantConfigId": "5ee168e8597be5002af7b454",
"createdAt": "2021-06-12T01:15:46.000Z",
"createdBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"paymentRequestCreatedBy": "crn::user:0af834c8-1110-11ec-9072-3e22fb52e878",
"activityNumber": "1"
}
]
}