Authorizations
Sanctum token-based authentication using the Bearer scheme. This is provided by the GrailPay Customer Support Team
Path Parameters
UUID of the transaction to refund
Body
application/json
Bank Accounts
- POSTValidate bank account and routing number ( STABLE )
- GETGet all bank accounts for a user ( STABLE )
- POSTAdd a new bank account for a user ( STABLE )
- DELDelete a bank account ( STABLE )
- GETFetch the bank account balance ( STABLE )
- GETFetch the transaction history for a bank account. ( STABLE )
- GETGet bank account details ( STABLE )
- POSTAdd bank account. ( SUNSETTING )
- GETGet all bank accounts for a user ( SUNSETTING )
- POSTGet balance approval ( STABLE )
- PUTSwitch default bank account ( STABLE )
- POSTGet User Details by bank account ( STABLE )
Users
- POSTOnboard a new Business or Merchant into the ACH application ( STABLE )
- POSTUpdate Business KYB ( STABLE )
- GETGet User ( STABLE )
- DELDeleting a User ( STABLE )
- GETGet All Users ( STABLE )
- POSTRegister a new business ( DEPRECATED )
- POSTUpdate Business KYB ( DEPRECATED )
- POSTOnboard a new person ( STABLE )
Payouts
- GETGet Business Batch Payout ( STABLE )
- GETList Business Batch Payouts ( STABLE )
- GETGet Merchant Batch Payout ( STABLE )
- GETList Merchant Batch Payouts ( STABLE )
- GETGet Person Batch Payout ( STABLE )
- GETList Person Batch Payouts ( STABLE )
- GETGet Processor Batch Payout ( STABLE )
- GETList Processor Batch Payouts ( STABLE )
- GETGet Batch Payout ( SUNSETTING )
- GETGet All Batch Payouts ( SUNSETTING )
- GETGet Batch Merchant Payout ( SUNSETTING )
- GETFetch a Batch Payout ( Processor Only ) ( SUNSETTING )
Refunds
Transactions
Refund a transaction ( STABLE )
Copy
Ask AI
curl --request POST \
--url https://api.grailpay.com/3p/api/v1/transactions/{uuid}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 100,
"client_reference_id": "123456"
}'Copy
Ask AI
{
"status": true,
"message": "",
"data": {
"uuid": "d1b3b3b0-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"transaction_uuid": "d1b3b3b0-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"amount": 100,
"status": "REFUND_PENDING",
"client_reference_id": "123456",
"created_at": "2021-09-01 12:00:00"
},
"errors": null,
"error_code": null
}Refunds
Refund a transaction ( STABLE )
Once a transaction has been completed, this API can be used to issue a refund, thereby clawing back funds from the payee and transferring them back to the payor. An optional amount can be specified to either issue a partial refund or add additional fees to the original amount. If the amount is not specified, the total transaction amount is refunded.
POST
/
3p
/
api
/
v1
/
transactions
/
{uuid}
/
refund
Refund a transaction ( STABLE )
Copy
Ask AI
curl --request POST \
--url https://api.grailpay.com/3p/api/v1/transactions/{uuid}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 100,
"client_reference_id": "123456"
}'Copy
Ask AI
{
"status": true,
"message": "",
"data": {
"uuid": "d1b3b3b0-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"transaction_uuid": "d1b3b3b0-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
"amount": 100,
"status": "REFUND_PENDING",
"client_reference_id": "123456",
"created_at": "2021-09-01 12:00:00"
},
"errors": null,
"error_code": null
}⌘I