Transaction Delivery
Read on how to request for and get status of delivery of a transaction

Delivery Request

Once the transaction has been created, you will need to request initialization of transaction delivery using this API. Delivery request can be initiated in the following scenarios:
  • Transaction Status is in PENDING or PROCESSED state
  • Transaction 'Type' is DEFAULT i.e. Not a REFUND transaction
Until delivery is requested and approved, the transaction will not be forwarded for payout.

PATCH /users/{{user_id}}/transactions/delivery-requests/{{id}}

Request sample
Response sample
1
curl --location -g --request PATCH '{{url}}/users/{{user_id}}/transactions/delivery-requests/{{id}}' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"status": "DELIVERY_REQUESTED",
7
"comment": "string"
8
}'
Copied!
1
Http status 204 (No Content)
Copied!

Update Delivery Status

For clients using their own payout network to deliver a transaction, the status of the delivery needs to be updated on our system using this API. Statuses need to be updated to DELIVERED for completed transactions and DELIVERY_FAILED for transactions which could not be completed.

POST /users/{{user_id}}/transactions/{{id}}/delivery-details

Request Sample
Response Sample
1
curl --location --request POST '{{url}}/users/{{user_id}}/transactions/{id}/delivery-details
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"date_delivered" : "2019-07-06",
7
"status" : "DELIVERED",
8
"reference_number" : 5657575
9
}
Copied!
1
Http status 204 (No Content)
Copied!