131 lines
4.3 KiB
Plaintext
131 lines
4.3 KiB
Plaintext
GET /payables/rtps/{rtpID}/atps
|
|
|
|
|
|
"/payables/rtps/{objectID}/atps"
|
|
|
|
|
|
|
|
|
|
"get": {
|
|
"summary": "Gets all Attempts to Pay (ATP) for a Request to Pay (RTP).",
|
|
"description": "Return a list of Attempts to Pay (ATPs) for a specific Request to Pay (RTP)",
|
|
"tags": [ "payments" ],
|
|
"operationId": "listPayablesATP",
|
|
"parameters": [
|
|
{ "$ref": "#/parameters/objectID" }
|
|
],
|
|
"responses": {{
|
|
"201": {
|
|
"description": "Successfully list associated ATP.",
|
|
"schema":{
|
|
"allOf": [
|
|
{"$ref": "#/definitions/TransactionSucceededInfo"},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"rtpID": {"$ref": "#/definitions/object-id"}
|
|
},
|
|
"required": [ "rtpID" ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Validation failed",
|
|
"schema":{
|
|
"allOf": [
|
|
{"$ref": "#/definitions/badParametersInfo"},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"rtpID": {"$ref": "#/definitions/object-id"}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Invalid key",
|
|
"schema":{
|
|
"allOf": [
|
|
{"$ref": "#/definitions/ErrorInfo"},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"atpID": {"$ref": "#/definitions/object-id"}
|
|
},
|
|
"required": [ "rtpID" ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "General error response format",
|
|
"schema":{
|
|
"allOf": [
|
|
{"$ref": "#/responses/GeneralError"},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"atpID": {"$ref": "#/definitions/object-id"}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
succesfull payment attempts
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{
|
|
"_id": ObjectId("0123456789abcdef01234567"),
|
|
"RtpID": "0123456789abcdef01234567",
|
|
"PayeeID": "0123456789abcdef01234567",
|
|
"PayerID": "0123456789abcdef01234567",
|
|
"PayeeInstrument": {
|
|
"_id": ObjectId("0123456789abcdef01234567"),
|
|
"AccountType": "Worldpay Online Payments Account",
|
|
"Description": "BloggsCo Inc. account."
|
|
},
|
|
"PayerInstrument": {
|
|
"Payer": {
|
|
"Email": "a@example.com",
|
|
"FirstName": "Joe",
|
|
"LastName": "Bloggs"
|
|
},
|
|
"PayerInstrument": {
|
|
"_id": ObjectId("0123456789abcdef01234567"),
|
|
"AccountType": "Credit/Debit Payment Card",
|
|
"Description": "My payment card"
|
|
}
|
|
},
|
|
"Amount": {
|
|
"Value": 220,
|
|
"Currency": "GBP"
|
|
},
|
|
"TransactionDetails": {
|
|
"OrderDescription": "2 Calling Birds, 1 Partridge in a Pear tree"
|
|
},
|
|
"Status": "Paid",
|
|
"ResultDetails": {
|
|
"ProcessorResponse": {
|
|
"StatusCode": 200,
|
|
"TransactionID": "76ebfbaa-7cd9-4f01-bd18-a32681f33133",
|
|
"RiskScore": 1
|
|
}
|
|
},
|
|
"LastUpdate": ISODate("2018-04-06T10:20:38.014Z"),
|
|
"LastVersion": 1
|
|
}
|
|
|
|
|
|
|