Fetch payment link - API Reference

Request

Path Params

id

string <uuid>

required

An unique identifier

Example:

3fa85f64-5717-4562-b3fc-2c963f66afa6

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

OK

Body

id

string <uuid>

optional

url

string <uri>

optional

amount

object

optional

currency

string

optional

value

number

optional

customer

object

optional

firstName

string

optional

lastName

string

optional

email

string

optional

items

array [object {3}]

optional

name

string

optional

price

number

optional

quantity

number

optional

merchant

object

optional

uuid

string

optional

shopUuid

string

optional

terminalUuid

string

optional

transactionId

string

optional

terminalId

string

optional

expirationDate

string <date-time>

optional

status

string

optional

createdAt

string

optional

hidden

boolean

optional

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "url": "http://example.com",
    "amount": {
        "currency": "string",
        "value": 0
    },
    "customer": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
    },
    "items": [
        {
            "name": "string",
            "price": 0,
            "quantity": 0
        }
    ],
    "merchant": {
        "uuid": "string",
        "shopUuid": "string",
        "terminalUuid": "string",
        "transactionId": "string",
        "terminalId": "string"
    },
    "expirationDate": "2019-08-24T14:15:22Z",
    "status": "string",
    "createdAt": "string",
    "hidden": true
}

🟠404Record Not Found