Skip to content
This repository has been archived by the owner on Feb 25, 2020. It is now read-only.

Commit

Permalink
docs/api: Add response example for GET /payments
Browse files Browse the repository at this point in the history 
Add to the API spec a response example to the GET /payments endpoint.
  • Loading branch information
@ifraixedes
ifraixedes committed Mar 23, 2019
1 parent 14eb5b7 commit c30c03a
Showing 1 changed file with 137 additions and 0 deletions.
137 changes: 137 additions & 0 deletions docs/api/paths/payments.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,143 @@
}
}
}
},
"example": {
"data": [
{
"type": "Payment",
"id": "4ee3a8d8-ca7b-4290-a52c-dd5b6165ec43",
"version": 0,
"organisation_id": "743d5b63-8e6f-432e-a8fa-c5d8d2ee5fcb",
"attributes": {
"amount": "100.21",
"beneficiary_party": {
"account_name": "W Owens",
"account_number": "31926819",
"account_number_code": "BBAN",
"account_type": 0,
"address": "1 The Beneficiary Localtown SE2",
"bank_id": "403000",
"bank_id_code": "GBDSC",
"name": "Wilfred Jeremiah Owens"
},
"charges_information": {
"bearer_code": "SHAR",
"sender_charges": [
{
"amount": "5.00",
"currency": "GBP"
},
{
"amount": "10.00",
"currency": "USD"
}
],
"receiver_charges_amount": "1.00",
"receiver_charges_currency": "USD"
},
"currency": "GBP",
"debtor_party": {
"account_name": "EJ Brown Black",
"account_number": "GB29XABC10161234567801",
"account_number_code": "IBAN",
"address": "10 Debtor Crescent Sourcetown NE1",
"bank_id": "203301",
"bank_id_code": "GBDSC",
"name": "Emelia Jane Brown"
},
"end_to_end_reference": "Wil piano Jan",
"fx": {
"contract_reference": "FX123",
"exchange_rate": "2.00000",
"original_amount": "200.42",
"original_currency": "USD"
},
"numeric_reference": "1002001",
"payment_id": "123456789012345678",
"payment_purpose": "Paying for goods/services",
"payment_scheme": "FPS",
"payment_type": "Credit",
"processing_date": "2017-01-18",
"reference": "Payment for Em's piano lessons",
"scheme_payment_sub_type": "InternetBanking",
"scheme_payment_type": "ImmediatePayment",
"sponsor_party": {
"account_number": "56781234",
"bank_id": "123123",
"bank_id_code": "GBDSC"
}
}
},
{
"type": "Payment",
"id": "32ba0ec1-0ba5-4271-9aa8-d2559be9d036",
"version": 1,
"organisation_id": "743d5b63-8e6f-432e-a8fa-c5d8d2ee5fcb",
"attributes": {
"amount": "9.56",
"beneficiary_party": {
"account_name": "W Owens",
"account_number": "31926819",
"account_number_code": "BBAN",
"account_type": 0,
"address": "1 The Beneficiary Localtown SE2",
"bank_id": "403000",
"bank_id_code": "GBDSC",
"name": "Wilfred Jeremiah Owens"
},
"charges_information": {
"bearer_code": "SHAR",
"sender_charges": [
{
"amount": "5.00",
"currency": "GBP"
},
{
"amount": "10.00",
"currency": "USD"
}
],
"receiver_charges_amount": "1.00",
"receiver_charges_currency": "USD"
},
"currency": "GBP",
"debtor_party": {
"account_name": "EJ Brown Black",
"account_number": "GB29XABC10161234567801",
"account_number_code": "IBAN",
"address": "10 Debtor Crescent Sourcetown NE1",
"bank_id": "203301",
"bank_id_code": "GBDSC",
"name": "Emelia Jane Brown"
},
"end_to_end_reference": "Wil piano Jan",
"fx": {
"contract_reference": "FX123",
"exchange_rate": "2.00000",
"original_amount": "200.42",
"original_currency": "USD"
},
"numeric_reference": "1002001",
"payment_id": "123456789012345678",
"payment_purpose": "Paying for goods/services",
"payment_scheme": "FPS",
"payment_type": "Credit",
"processing_date": "2017-01-18",
"reference": "Payment for Em's piano lessons",
"scheme_payment_sub_type": "InternetBanking",
"scheme_payment_type": "ImmediatePayment",
"sponsor_party": {
"account_number": "56781234",
"bank_id": "123123",
"bank_id_code": "GBDSC"
}
}
}
],
"meta": {
"total": 2
}
}
}
}
Expand Down

0 comments on commit c30c03a

Please sign in to comment.