Payment Schedular
The Payment Scheduler APIs provide functionality for managing and scheduling payments within a system.
These APIs allow users to create, retrieve, and update payment schedules based on specific criteria such as sender account, receiver account, amount, transfer type, date, and timezone.
Base URL
https://api.globalbanking.fintractglobal.com/
1. Get all scheduled payments
This API endpoint allows bank-admins to view all the scheduled payments associated with their bank. It provides essential information such as sender account, receiver account, amount, transfer type, date, and timezone for each scheduled payment.
Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.
Endpoint
/schedular/
Request
Header Parameters
Authorization*:
string
Bearer access token for authorization.
Response
200
Response body schema
application/json
[]:
array
Array containing details of scheduled payments
id:
string
sender_account:
string
receiver_account:
string
amount:
integer
status:
string
bank_id:
string
date:
string
Sample Request
Payload
No payload
Sample Response
200
application/json
[
{
"id": "efb9aae52f314f6fb4e8a93e751da0f8",
"sender_account": "5264312534654543725",
"receiver_account": "4692443454345852371",
"amount": 100.0,
"status": "APPROVED",
"bank_id": "99c72ecdbff44c3da8e76225ef5457ed",
"date": "2023-05-25T22:26:00Z"
},
{
"id": "ed3d56aabb1340509ae85545ff7e5dcd",
"sender_account": "5264312534654543725",
"receiver_account": "4692443454345852371",
"amount": 100.0,
"status": "APPROVED",
"bank_id": "99c72ecdbff44c3da8e76225ef5457ed",
"date": "2023-06-30T08:38:00Z"
},
{
"id": "eecb5c3f581b4a4daacd330686794460",
"sender_account": "5264312534654543725",
"receiver_account": "4692443454345852371",
"amount": 155.0,
"status": "APPROVED",
"bank_id": "99c72ecdbff44c3da8e76225ef5457ed",
"date": "2023-07-02T14:03:00Z"
}
]To test the API,click here to access our testing interface.
2. Schedule payment
This endpoint is used to schedule a payment by providing payment data. This requires authentication using a customer's access token.
Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.
Endpoint
/schedular/
Request
Header Parameters
Authorization*:
string
Bearer access token for authorization.
Request body schema
application/json
sender_account:
string
Sender's account number
receiver_account:
string
Receiver's account number
amount:
string
Amount to be transferred
transfer_type:
string Enum: [P2P, Food, Electricity, self, Custom]
Type of transfer
date:
string
Date of the scheduled payment yyyy-mm-dd
timezone:
string
Timezone of the scheduled payment
Response
201
Response body schema
application/json
msg:
string
Ticket added successfully
data:
object
Object containing deatils of scheduled payment
id:
string
sender_account:
string
receiver_account:
string
amount:
string
status:
string
bank_id:
string
date:
string
Sample Request
Payload
application/json
{
"sender_account": "123456789091",
"receiver_account": "987654321117",
"amount": "100",
"transfer_type": "P2P",
"date": "2024-03-22",
"timezone": "Asia/Kolkata"
}Sample Response
201
application/json
{
"msg": "Ticket added successfully",
"data": {
"id": "d8f01a01djh7468843ths91140d614b",
"sender_account": "123456789091",
"receiver_account": "987654321117",
"amount": "100",
"status": "PENDING",
"bank_id": "99c72ecdbff44c3da8e76115ef5457ed",
"date": "2024-03-22"
}
}To test the API,click here to access our testing interface.
3. Update scheduled payment
This endpoint takes payment id & status and updates only status. This requires authentication using a bank-admin's access token.
Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.
Endpoint
/schedular/
Request
Header Parameters
Authorization*:
string
Bearer access token for authorization.
Request body schema
application/json
id*:
string
ID of scheduled payment
status*:
string Enum:[APPROVED,PENDING]
Status of the payment
Response
200
Response body schema
application/json
msg:
string
Scheduled payment updated
Sample Request
Payload
application/json
{
"id": "d8f01a01168ty4834t7tec91140d614b",
"status": "CLOSED"
}Sample Response
200
application/json
{
"msg": "Scheduled payment updated"
}To test the API,click here to access our testing interface.