v1
latestOpenAPI 3.0.12026-07-24256962.9 KBPayments
Retrieve a single Payment
get/payments/{id}
Path parameters
idstring uuid required
The ID of the Payment
Query parameters
payerIdstring uuid required
The Payer ID associated with the Payment
Headers
Trace-Idstring
A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.
End-User-Agentstring
A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.
End-User-Ipstring
The IP address of the end user. Recommended for compliance.
End-User-OSstring
The Operating System of the end user. Recommended for compliance.
End-User-Device-Idstring
A unique identifier for the end user's device. Recommended for compliance.
End-User-Device-Manufacturerstring
The manufacturer of the device used by the end user. Recommended for compliance.
End-User-Device-Modelstring
The device model used by the end user. Recommended for compliance.
Response
A Payment object
Example response
{
"id": "bbe023aa-ccd6-4bfc-a209-c6bb5859a9a8",
"fees": [
{
"amount": {
"value": 2.9
},
"rate": "2.90%"
}
],
"sourceAmount": {
"value": 102.9
},
"targetAmount": {
"value": 100
},
"paymentMethod": {
"id": "6f0eb884-3f41-4b57-b86a-80f62dca011e"
},
"recipient": {
"id": "a8d4e641-e130-43d1-90a0-9717561539aa"
},
"payer": {
"id": "8f51c396-6e29-49a6-ba5a-1a31d5420158"
},
"details": {
"accountName": "Jen Doe",
"accountNumber": "647823643287423",
"memo": "Payment for Oct. coffee beans inventory",
"disbursementInformation": {
"bankName": "Silicon Valley Bank"
},
"traceInformation": {
"reference": "125109006"
}
},
"deliveryDate": "2020-11-20",
"createdAt": "2020-11-19T01:35:55.096Z",
"status": "DEPOSITED",
"statusReasons": [
{
"code": "STATUS_REASON_CODE",
"message": "Some message to help resolve status issue."
}
],
"sourceDescriptor": "PQ Coffee Beans Supply Co #ARSSDF45",
"targetDescriptor": "PQ Philz Coffee #ARSSDF45"
}