Retrieve a Payment
GET/payments/:id
Fetches detailed information on a specific payment by id
.
Request
Path Parameters
id stringrequired
ID of the Payment
.
Responses
- 200
- 401
- 403
- 404
Payment details
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
id string
amount string
stellar_transaction_id string
stellar_operation_id string
status string
Possible values: [DRAFT
, READY
, PENDING
, PAUSED
, SUCCESS
, FAILED
]
status_history object[]
status string
Possible values: [DRAFT
, READY
, PENDING
, PAUSED
, SUCCESS
, FAILED
]
status_message string
timestamp date-time
disbursement object
id uuid
The unique identifier of the disbursement
name string
The name of the disbursement
status string
Possible values: [DRAFT
, READY
, STARTED
, PAUSED
, COMPLETED
]
created_at date-time
The creation timestamp of the disbursement
updated_at date-time
The last update timestamp of the disbursement
asset object
id string
code string
Asset code
issuer string
Asset issuer address
created_at date-time
updated_at date-time
deleted_at date-time
receiver_wallet object
id string
receiver object
id string
wallet object
id string
name string
homepage string
stellar_address string
created_at string
updated_at string
status string
Possible values: [DRAFT
, READY
, REGISTERED
, FLAGGED
]
created_at date-time
updated_at date-time
{
"id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
"amount": "100.00",
"stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
"stellar_operation_id": "string",
"status": "DRAFT",
"status_history": [
{
"status": "DRAFT",
"status_message": "string",
"timestamp": "2023-02-03T10:45:51.000Z"
}
],
"disbursement": {
"id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
"name": "disbursement-june-29",
"status": "DRAFT",
"created_at": "2023-06-30T01:22:57.831975Z",
"updated_at": "2023-06-30T01:22:58.316511Z"
},
"asset": {
"id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
"code": "USDC",
"issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
"created_at": "2023-02-03T10:45:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z",
"deleted_at": "2023-06-03T10:55:51.000Z"
},
"receiver_wallet": {
"id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
"receiver": {
"id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
},
"wallet": {
"id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
"name": "Vibrant Assist",
"homepage": "https://vibrantapp.com"
},
"stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
"created_at": "2023-02-03T10:45:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z",
"status": "DRAFT"
},
"created_at": "2023-02-03T10:45:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
extras object
status number
message string
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
Forbidden
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
{
"error": "Forbidden"
}
{
"error": "Forbidden"
}
Not Found
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
extras object
status number
message string
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Payment not found"
}
}
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Payment not found"
}
}
Loading...