Lean Technologies Refunds API
The Refunds API from Lean Technologies — 2 operation(s) for refunds.
OpenAPI Specification
openapi: 3.1.0
info:
title: Consents Account On File Account Controls (New) Account Controls (New) Refunds API
version: v0.2.3
servers:
- url: https://sandbox.leantech.me
description: Sandbox
- url: https://api2.leantech.me
description: Production
security:
- bearerAuth: []
tags:
- name: Refunds
paths:
/payouts/refunds:
post:
summary: Create Refunds
deprecated: false
description: Creates and queues a refund payment for approval or rejection. Refunds are always returned to the originating account of the corresponding payment. The total refund amount cannot exceed the original payment. For processing amounts greater than the original payment, please refer to payouts.
operationId: createRefund
tags:
- Refunds
parameters:
- name: Content-Type
in: header
description: ''
required: true
example: application/json
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
payment_id:
type: string
description: Unique identifier for the corresponding intitiated payment
amount:
type: integer
description: 'The refund amount to be processed.
'
currency:
type: string
description: The ISO 3 letter currency code for the account stores value in.
reason_code:
type: string
description: Code indicating the reason for the refund
enum:
- FRAUDULENT_PAYMENT
- ORDER_CANCELLED
- DUPLICATED_PAYMENT
- CUSTOMER_REQUEST
description:
type: string
description: "Additional notes about the refund being created. \nCan include order references/customer-id for the refund being generated."
external_reference:
type: string
description: Useful for tracking and reporting the transaction on your end. e.g You can enter transaction ID of this refund maintained in your system
status:
type: string
description: Refers to the transaction status of the refund being created.
enum:
- CREATED
- APPROVED
default: CREATED
required:
- payment_id
- reason_code
- amount
example:
- payment_id: 00fdbc90-8116-42b2-bf26-5665b05bfb6b
amount: 7
currency: AED
reason_code: DUPLICATED_PAYMENT
description: Refund isused for Order NO. 21342322123
external_reference: '21451234567'
responses:
'201':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
properties:
refund_id:
type: string
description: Unique identifier for the refund inititated
payment_id:
type: string
description: Unique identifier for the payment inititated
status:
type: string
description: "Status of the payment. \nDefault is INITIATED. Acceptable values: INITIATED or CONFIRMED"
enum:
- CREATED
- APPROVED
- ''
amount:
type: number
description: 'The refund amount to be processed.
'
currency:
type: string
description: The ISO 3 letter currency code for the refund amount
reason_code:
type: string
description: Code indicating the reason for the refund
enum:
- CUSTOMER_REQUEST
- DUPLICATED_PAYMENT
- ORDER_CANCELLED
- FRAUDULENT_PAYMENT
description:
type: string
description: 'Additional notes about the refund being created.
Can include order references/customer-id for the refund being generated'
external_reference:
type: string
description: Useful for tracking and reporting the transaction on your end. e.g You can enter transaction ID of this refund maintained in your system
beneficiary:
type: object
properties:
name:
type: string
description: Defines the name of the benefeciary.
iban:
type: string
description: Defines the IBAN of the benefeciary
city:
type: string
description: 'Defines city of Benefeciary. Defaults to Dubai
'
required:
- name
- city
- iban
required:
- payment_id
- status
- amount
- currency
- description
- refund_id
- external_reference
- 01JKRHNSR3FP3SP1EZDFNB4FKP
- reason_code
example:
- refund_id: d7427d13-0b4c-4e67-8b23-7c9ba03d95e3
payment_id: 00fdbc90-8116-42b2-bf26-5665b05bfb6b
status: CREATED
amount: 0.01
currency: AED
reason_code: DUPLICATED_PAYMENT
description: Refund isused for Order NO. 21342322123
external_reference: '21451234567'
beneficiary:
name: Jay Sheron
iban: SA10000000000023
city: Dubai
headers: {}
security:
- bearer: []
put:
summary: Process Refunds
deprecated: false
description: 'Updates the refund status based on the approver''s (or checker''s) confirmation or rejection. This serves as a fail-safe mechanism to validate the refund decision after the transaction is initiated, rather than processing it immediately. '
operationId: processRefunds
tags:
- Refunds
parameters:
- name: Content-Type
in: header
description: ''
required: true
example: application/json
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
refund_id:
type: string
description: 'Refers to the unique identity of the refund to be updated.
'
status:
type: string
description: 'Refers to the updated status of the refund. '
enum:
- APPROVED
- REJECTED
required:
- refund_id
- status
example:
- refund_id: 5d43a659-a4cf-4f56-af66-ad6478d61890
status: CONFIRMED
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
refund_id:
type: string
description: 'Refers to the unique ID of the refund being updated.
'
status:
type: string
description: 'Refers to the updated status of the refund.
'
enum:
- APPROVED
- REJECTED
required:
- status
- refund_id
example:
- refund_id: 5d43a659-a4cf-4f56-af66-ad6478d61890
status: REJECTED
headers: {}
security:
- bearer: []
get:
summary: List Refunds
deprecated: false
description: Returns a list of all refunds intitated . You can filter the transactions based on status of the refund transaction by passing it in the query parameter. This API allows pagination with the default size of 50 refunds per page.
operationId: listRefunds
tags:
- Refunds
parameters:
- name: status
in: query
description: Fetch all refund transactions based on the entered refund payment status.
required: false
example: ''
schema:
type: string
enum:
- CREATED
- REJECTED
- APPROVED
- FAILED
- ACCEPTED_BY_BANK
- PENDING_WITH_BANK
- name: size
in: query
description: Defines the number of transactions per page hence manages payload size
required: false
schema:
type: integer
default: 50
- name: page
in: query
description: Specifies the page number to retreive. e.g if page=2 and size=50, the API will return records from 101 to 150
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
refund_id:
type: string
description: Unique identifier for the refund transaction.
deposit_amount:
type: number
description: The deposit amount associated with the refund request.
deposit_currency:
type: string
description: The ISO 3 letter currency code for the deposit amount
payment_id:
type: string
description: Identifier of the payment transaction linked to this refund.
status:
type: string
description: Current status of the refund process.
enum:
- CREATED
- APPROVED
- REJECTED
- ACCEPTED_BY_BANK
- PENDING_WITH_BANK
- FAILED
amount:
type: number
description: The amount that will be refunded
currency:
type: string
description: The ISO 3 letter currency code for the refund amount
reason_code:
type: string
description: Reason for the refund request
enum:
- CUSTOMER_REQUEST
- DUPLICATED_PAYMENT
- ORDER_CANCELLED
- FRAUDULENT_PAYMENT
description:
type: string
description: "Additional notes about the refund being created. \nCan include order references/customer-id for the refund being generated."
external_reference:
type: string
description: Useful for tracking and reporting the transaction on your end. e.g You can enter transaction ID of this refund maintained in your system
benefeciary:
type: object
properties:
name:
type: string
description: Name of the beneficiary to which refund is being processed
iban:
type: string
description: IBAN account details of benefeicary
city:
type: string
default: Dubai
description: City associated with the beneficiary account
required:
- city
- iban
- name
created_at:
type: string
format: date-time
description: Timestamp when the refund was created
created_by:
type: string
description: Identifier of the user that initiated the refund
actioned_by:
type: string
description: Identifier of the user that confirmed or rejected the refund
required:
- created_at
- created_by
- refund_id
- deposit_amount
- deposit_currency
- payment_id
- status
- amount
- currency
- reason_code
- description
- external_reference
- benefeciary
example:
content:
- refund_id: 8161d683-88f7-4c13-b4f5-1e9cb13a49c1
deposit_amount: 15.34
deposit_currency: AED
payment_id: b16b66fa-3cb0-433e-a8c8-5e0467e4c9d6
status: ACCEPTED_BY_BANK
amount: 15.34
currency: AED
reason_code: FRAUDULENT_PAYMENT
description: 8N&[as39q_
external_reference: x8VerE
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T11:36:17.899660Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: f41b1b7a-bd15-432b-9fff-a621b68675a4
- refund_id: d7d85efa-6fd9-4452-9ca5-850f7ada845d
deposit_amount: 10.35
deposit_currency: AED
payment_id: 9c6cbf27-f2fb-44f6-a0be-57506a144440
status: ACCEPTED_BY_BANK
amount: 10.35
currency: AED
reason_code: CUSTOMER_REQUEST
description: 0`fZ&P1;:@
external_reference: sqo YT
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T11:36:16.941592Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: b231582c-4e4c-4f86-8cae-75c5356eab06
- refund_id: 6c6ab9df-5a6e-4f79-8ff4-07e94cdfdd1d
deposit_amount: 13.55
deposit_currency: AED
payment_id: 7caf7c3e-8e8e-48d9-9e2b-0c2e03f236c0
status: CREATED
amount: 13.55
currency: AED
reason_code: CUSTOMER_REQUEST
description: QA refund initiation
external_reference: SMN9DH
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T11:36:31.134243Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: de848b84-5dd9-4178-9f07-4e42fee93d67
deposit_amount: 18.62
deposit_currency: AED
payment_id: 80248e0e-588b-4bde-b531-919abc0e68ae
status: CREATED
amount: 18.62
currency: AED
reason_code: DUPLICATED_PAYMENT
description: kVk&sP7V_s
external_reference: I0o6t0
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T11:36:29.915697Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: f3284877-da5e-4fb7-8e55-c41a4fb4fedc
deposit_amount: 18.25
deposit_currency: AED
payment_id: 5a9b61f7-88f4-4378-a932-2ae0082d4f42
status: ACCEPTED_BY_BANK
amount: 18.25
currency: AED
reason_code: CUSTOMER_REQUEST
description: XSb#3iAuH{
external_reference: mzCLJf
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T09:19:32.122751Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 7837da43-a5c9-4777-b7d7-1c7f3f3d66d6
- refund_id: b73611bb-7a73-4b38-84af-7c27558fd03c
deposit_amount: 15.34
deposit_currency: AED
payment_id: 7053b95c-b5c2-4f2c-ba59-879a2ab27bf9
status: APPROVED
amount: 15.34
currency: AED
reason_code: FRAUDULENT_PAYMENT
description: ',aZwDar32@'
external_reference: csxXf4
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T09:07:54.714141Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 37f5b0c3-b9f4-487e-aec3-36ee9deffafc
- refund_id: cc1af5a0-b9df-4377-bca6-4c4d5827e9b5
deposit_amount: 18.42
deposit_currency: AED
payment_id: a7c33c83-4c34-448f-93bf-fce721413733
status: CREATED
amount: 18.42
currency: AED
reason_code: ORDER_CANCELLED
description: Xsj3^ Y53
external_reference: GUnW1J
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T09:07:40.845413Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 0f01a43d-e4d5-4da0-a524-dad9daa1ade3
deposit_amount: 17.55
deposit_currency: AED
payment_id: 2b74f624-8ca9-40fc-b8c7-0835b6a52201
status: CREATED
amount: 17.55
currency: AED
reason_code: CUSTOMER_REQUEST
description: QA refund initiation
external_reference: eXGSNb
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-28T09:07:27.057079Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 8e1c8094-8fba-40f4-bbbe-df6f1325f849
deposit_amount: 15.34
deposit_currency: AED
payment_id: 73727d12-c60b-4697-b57c-04e8a411cc0e
status: ACCEPTED_BY_BANK
amount: 15.34
currency: AED
reason_code: DUPLICATED_PAYMENT
description: bc>W!{o6$e
external_reference: fQ4Hom
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:35.525332Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 582de6bb-1108-46d8-9f02-f404a3f51f41
- refund_id: 41aacc33-ca14-4509-adf4-02998a62e465
deposit_amount: 19.51
deposit_currency: AED
payment_id: 501169c4-0af3-440e-82f3-2fd12c581832
status: ACCEPTED_BY_BANK
amount: 19.51
currency: AED
reason_code: CUSTOMER_REQUEST
description: _krSH86Lo4
external_reference: 4xSMFI
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:34.732135Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 7ffea5af-5067-4500-a3a3-823bbf63c169
- refund_id: c0a57ad4-bc43-44d0-9cde-33d4d78dff1e
deposit_amount: 14.6
deposit_currency: AED
payment_id: 5c453616-b72d-469e-ac0b-a59863e123cb
status: ACCEPTED_BY_BANK
amount: 14.6
currency: AED
reason_code: ORDER_CANCELLED
description: Jrk9YG2b#@
external_reference: 8Fy27W
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:08:54.856670Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 30cad392-8865-4785-bb8d-0b7d13b6c204
- refund_id: 8724b494-4b8d-488e-a4f6-5444c05b3c1d
deposit_amount: 15.34
deposit_currency: AED
payment_id: 4cb52f8d-91c4-40e2-b5bf-db97d3a7f943
status: ACCEPTED_BY_BANK
amount: 15.34
currency: AED
reason_code: CUSTOMER_REQUEST
description: w`2x!ckWFq
external_reference: 7JZrDT
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:08:55.229138Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: deb997f1-d261-49b0-9b27-f11bcbed2c89
- refund_id: 623a3cff-0fcd-44a1-aa23-ba473eb373d4
deposit_amount: 16.35
deposit_currency: AED
payment_id: afa65c92-7b01-4ec3-b473-7d322dcdeeca
status: CREATED
amount: 16.35
currency: AED
reason_code: CUSTOMER_REQUEST
description: QA refund initiation
external_reference: knrRpk
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:47.303748Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 261aac81-4030-47e1-9091-30b4e82179d3
deposit_amount: 15.15
deposit_currency: AED
payment_id: bee462a1-5156-4aae-90dd-f549914651d5
status: CREATED
amount: 15.15
currency: AED
reason_code: ORDER_CANCELLED
description: POYoOVCx^Q
external_reference: Lw7GxW
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:46.449358Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: d9a74217-8a72-4cee-a4a7-d289389f08d5
deposit_amount: 15.94
deposit_currency: AED
payment_id: c70871c8-2caf-4fe3-80aa-cc45c9b22b1c
status: CREATED
amount: 15.94
currency: AED
reason_code: CUSTOMER_REQUEST
description: QA refund initiation
external_reference: NlSA4M
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:06.392478Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 1536c4c4-2f9f-4142-b5a7-61b74599ccd8
deposit_amount: 19.5
deposit_currency: AED
payment_id: d5941b8b-2045-4318-b162-c5bd34a05340
status: CREATED
amount: 19.5
currency: AED
reason_code: CUSTOMER_REQUEST
description: B?4QI;?A(e
external_reference: kt97gL
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T17:09:00.663644Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 0a19c0dc-d6bb-46ca-b60a-2f680c477482
deposit_amount: 15.34
deposit_currency: AED
payment_id: 1606c287-2d10-48db-aec4-e0b4dcbf379f
status: ACCEPTED_BY_BANK
amount: 15.34
currency: AED
reason_code: ORDER_CANCELLED
description: i&,RDGi`J1
external_reference: b2WfBS
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T08:37:58.351630Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 132f1b8e-8b31-4e87-980c-3d34d567ed51
- refund_id: e4e94108-4bb4-4f45-b362-5d0dc41124c7
deposit_amount: 19.81
deposit_currency: AED
payment_id: 8f2c87ef-9c3c-4b0d-8b60-a66cbf5770cd
status: ACCEPTED_BY_BANK
amount: 19.81
currency: AED
reason_code: FRAUDULENT_PAYMENT
description: YqDCHd$&Gq
external_reference: h85Fmm
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T08:37:56.653606Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 0082d74c-07d2-493f-9a94-7cee7f80b437
- refund_id: 6ebf5f0f-b6bc-49ba-920b-e68399d20a4f
deposit_amount: 12.11
deposit_currency: AED
payment_id: 331288d4-fe29-4caa-be59-5df83b056502
status: CREATED
amount: 12.11
currency: AED
reason_code: CUSTOMER_REQUEST
description: QA refund initiation
external_reference: Wqj7G3
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T08:38:10.936716Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: d42b4385-2b92-4b61-9896-31b147458714
deposit_amount: 17.35
deposit_currency: AED
payment_id: 3cd62de6-8092-4be3-8bac-4d8a6d9c0892
status: CREATED
amount: 17.35
currency: AED
reason_code: ORDER_CANCELLED
description: ;LnlORBni6
external_reference: nbe9ac
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-21T08:38:07.425033Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: null
refund_intent_id: null
- refund_id: 7f36be50-5fef-46d3-85cd-443d964d7d5c
deposit_amount: 17.83
deposit_currency: AED
payment_id: 9a6b42e9-c703-492e-8d52-6e4d7606e170
status: ACCEPTED_BY_BANK
amount: 17.83
currency: AED
reason_code: FRAUDULENT_PAYMENT
description: Zf0:GKdMk(
external_reference: qkm3p1
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-20T13:00:44.322599Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 90452a2f-c9e9-4210-bb6c-ccc2d145329d
- refund_id: 8e377c16-e8cc-4171-b0e0-9d09632b65f4
deposit_amount: 15.34
deposit_currency: AED
payment_id: d9691228-11f7-4e88-a4ea-25499c8913df
status: ACCEPTED_BY_BANK
amount: 15.34
currency: AED
reason_code: CUSTOMER_REQUEST
description: Er;fEbR^rT
external_reference: fEpvVc
beneficiary:
name: Rolf Bogan
iban: AE280003008159427667010
city: Dubai
created_at: '2025-05-20T13:00:40.758911Z'
created_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
actioned_by: fe0f6434-4bf9-46eb-96ac-1a6e7396d27d
refund_intent_id: 40aef1d6-8bd5-4827-b4f8-b101a2ab8d54
- refund_id: b8d482cc-cbff-464e-866c-35a6aeca9ae8
deposit_amount: 18.94
deposit_currency: AED
payment_id: fd17be52-6a03-4639-b1ed-d546118c1f23
status: CREATED
amount: 18.94
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lean-technologies/refs/heads/main/openapi/lean-technologies-refunds-api-openapi.yml