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/{{transaction_id}}

Details

Delivery Request Object

Field	Required	Type	Description
status	Yes	String	Enumerated Value : DELIVERY_REQUESTED
comment	No	String	Comment / reason for requesting delivery
transaction_id	Yes	UUID	ID of the transaction for which delivery is being requested
user_id	Yes	UUID	ID of the user who created the transaction

Request sample

curl --location -g --request PATCH '{{url}}/users/{{user_id}}/transactions/delivery-requests/{{transaction_id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "status": "DELIVERY_REQUESTED",
  "comment": "string"
}'

Response sample

Http status 204 (No Content)

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/{{transaction_id}}/delivery-details

Details

Field	Required	Type	Description
status	Yes	String	Enumerated Value : DELIVERED, DELIVERY_FAILED
transaction_id	Yes	UUID	ID of transaction for which delivery status is being changed.
user_id	Yes	UUID	ID of the user who created the transaction
date_delivered	No	String	Date and time when the transaction was delivered (yyyy-mm-ddThh:mm:ss.ms)
reference_number	No	String	Client's reference number of the transaction

Request Sample

curl --location --request POST '{{url}}/users/{{user_id}}/transactions/{{transaction_id}}/delivery-details
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"date_delivered" : "2022-12-21T22:28:22.261767",
	"status" : "DELIVERED",
	"reference_number" : 5657575
}

Response Sample

Http status 204 (No Content)