Unwanted Incoming Payments (Payins) can be easily returned via the returns endpoints.
If you need to return funds to anyone other than the original or Existing Payee, the requirement will be to first create such a payee and only use it once it is ACTIVE with option Existing Payee selected.
Each return creates a dedicated Payment Returns object containing the details of the return, and is linked to the Payment that was returned by its id.
| Attribute | Description | Format/Enum |
|---|---|---|
| id string | Unique identifier of the return payment. | e.g. rtn_4jalpeo0em7bkx39z6 |
| paymentId string | Unique identifier of the payment for which the return was created. | e.g. pmt_nx83lr41ov7dy5va2g |
| payeeId string | Unique identifier of the payee to who the payment was returned. | e.g. pye_exz3l6d7b9n0myjr5v |
| reference string | Reference sent with the return. | Return reference must consist of at least 6 alphanumeric characters that are not all the same. Can contain special characters include space, hyphen(-), full stop (.), ampersand(&), and forward slash (/), which are uncounted. |
| amount string | Amount of the return payment in 2 decimal places. | e.g. 121.21 |
| currency string | Currency of the return payment. | Three-letter ISO 4217 code e.g. GBP, EUR , USD |
| paymentScheme string | Payment scheme used for the return payment. | FPS, CHAPS, SCT |
| status string | Status of the return payment. | CREATED, PROCESSING, COMPLETED, COMPLIANCE_REVIEW, FAILED, REJECTED |
| createdAt integer | Epoch timestamp at which the object was created. | e.g. 1637593856104 |
| updatedAt integer | Epoch timestamp at which the object was last updated. | e.g. 1637593856104 |