/v2/payments/{id}/tracking_info

GET

Get a payment Tracking Information.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescription
X-Auth-Token header string Authentication token.
id path string Payment UUID.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/{id}/tracking_info

Response

{
    "uetr": "46ed4827-7b6f-4491-a06f-b548d5a7512d",
    "transaction_status": {
        "status": "processing",
        "reason": "transferred_and_tracked"
    },
    "initiation_time": "2019-07-09T13:20:30+00:00",
    "completion_time": null,
    "last_update_time": "2019-07-10T15:39:08+00:00",
    "payment_events": [
        {
            "tracker_event_type": "customer_credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": null,
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T15:39:08+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": null,
            "interbank_settlement_date": null,
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T15:39:08+00:00"
        },
        {
            "tracker_event_type": "customer_credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": null,
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T14:22:41+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": null,
            "interbank_settlement_date": null,
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T14:22:41+00:00"
        },
        {
            "tracker_event_type": "credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": "BANABEBBXXX",
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T14:22:41+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": {
                "currency": "USD",
                "amount": "745437.57"
            },
            "interbank_settlement_date": "2019-07-09T00:00:00+00:00",
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T14:22:41+00:00"
        },
        {
            "tracker_event_type": "customer_credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": null,
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T14:22:41+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": null,
            "interbank_settlement_date": null,
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T14:22:41+00:00"
        },
        {
            "tracker_event_type": "customer_credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": null,
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T14:22:41+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": null,
            "interbank_settlement_date": null,
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T14:22:41+00:00"
        },
        {
            "tracker_event_type": "credit_transfer_payment_cancellation_request",
            "valid": true,
            "transaction_status": null,
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": null,
            "serial_parties": null,
            "sender_acknowledgement_receipt": "2019-07-10T14:17:39+00:00",
            "instructed_amount": null,
            "confirmed_amount": null,
            "interbank_settlement_amount": null,
            "interbank_settlement_date": null,
            "charge_amount": null,
            "charge_type": null,
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-10T14:22:41+00:00"
        },
        {
            "tracker_event_type": "customer_credit_transfer_payment",
            "valid": true,
            "transaction_status": {
                "status": "processing",
                "reason": "transferred_and_tracked"
            },
            "funds_available": null,
            "forwarded_to_agent": null,
            "from": "BANABEBBXXX",
            "to": "BANAUS33XXX",
            "originator": "BANABEBBXXX",
            "serial_parties": {
                "debtor": null,
                "debtor_agent": "GPMRCH30",
                "intermediary_agent1": null,
                "instructing_reimbursement_agent": null,
                "creditor_agent": "GPMRQAJ0",
                "creditor": null
            },
            "sender_acknowledgement_receipt": "2019-07-09T13:20:30+00:00",
            "instructed_amount": {
                "currency": "USD",
                "amount": "745437.57"
            },
            "confirmed_amount": null,
            "interbank_settlement_amount": {
                "currency": "USD",
                "amount": "745437.57"
            },
            "interbank_settlement_date": "2019-07-09T00:00:00+00:00",
            "charge_amount": null,
            "charge_type": "shared",
            "foreign_exchange_details": null,
            "last_update_time": "2019-07-09T13:20:50+00:00"
        }
    ]
}
Error Codes
HTTP Status Code Description Params
400 payment_tracking_info_failed payment_id should be in UUID format
payment_is_not_swift You cannot track non-swift payments
payment_is_not_executed This payment is not executed yet, please try again later
401 invalid_supplied_credentials Authentication failed with the supplied credentials
403 permission_denied You do not have permission 'payment_tracking' to perform this operation
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this post helpful?
Let us know if you liked the post. That’s the only way we can improve.
Yes
No