Receipts

Search…
Receipts
The receipt object
Attribute
Type
Description
description
string
The payment title.
reference_code
string
A generated reference code.
time
time
The time when the payment occurred.
payer.id
uuid
The unique identifier for the user sending the payment.
payer.title
string
The name of the user sending the payment.
payer.details
array
An optional list of strings with details about the user sending the payment, e.g. address.
recipient.id
uuid
The unique identifier for the user receiving the payment.
recipient.title
string
The name of the user receiving the payment.
recipient.details
array
An optional list of strings with details about the user receiving the payment, e.g. address.
payment_method.id
uuid
The unique identifier for the payment method.
payment_method.title
string
The payment method title.
payment_method.details
array
An optional list of strings with details about the payment method, e.g. card information.
amount.total
string
The formatted total amount of the payment in the currency in which the payment was made.
amount.paid
string
The formatted amount paid in the currency in which the payment was made.
amount.cost
string
The formatted cost amount paid in the currency in which the payment was made.
amount.currency
string
Three-letter ISO-4217 code. Must be a supported currency.
Example
{
  "description": "This is a payment description",
  "reference_code": "00002MC",
  "time": "2017-05-23T12:41:15.813817Z",
  "payer": {
    "id": "add5c52a-0c57-4d5c-7525-db14566f2f1a",
    "title": "John Dough (@johndough)",
    "details": null
  },
  "recipient": {
    "id": "90bcfb20-99fd-465d-6e23-2e19e8952420",
    "title": "Merchant Name",
    "details": [
      "Memento ehf. (700114-0580)",
      "Bolholti 4, 105 Reykjavík"
    ]
  },
  "payment_method": {
    "id": "79d94752-f94a-46ab-8793-7f6434025cf7",
    "title": "Credit Card",
    "details": [
      "MasterCard 1111",
      "Transaction #71574 - AuthCode #18902877"
    ]
  },
  "amounts": {
    "total": "€20.50",
    "paid": "€20.00",
    "cost": "€0.50",
    "currency": "EUR"
  }
}
Get a receipt
Get a receipt for the payment, if it has been fully processed. The sender and recipient will get different versions of the receipt; the sender will see the payment method while the recipient will not.
Request
Response
GET /v1/payments/{id}/receipt
200 OK
Returns a receipt object
Payment
Referrals
Last modified 2yr ago
Copy link
Outline
The receipt object
Example
Get a receipt