Mircate

Refund

Production

https://api.b2b.retter.io/5p1hp1d2t

POST

/CALL/WalletAPI/refund/{B2B_WALLET_PROJECT_ID}-{B2B_WALLET_ACCOUNT_ID}

Wallet

Last modified:2024-09-17 11:22:35

The refund method is used when processing a refund transaction from the wallet.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

B2B_WALLET_PROJECT_ID

string

required

B2B_WALLET_ACCOUNT_ID

string

required

Body Params application/json

amount

integer

optional

If 'Amount' is used, a partial refund transaction is processed. When 'Amount' is not used, a full refund is performed.

transactionId

string

required

currency

string

optional

walletId

string

optional

accountNumber

string

optional

Either accountNumber or walletId and currency are requeired.

Example

{
    "amount": 0,
    "transactionId": "string",
    "currency": "string",
    "walletId": "string",
    "accountNumber": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/WalletAPI/refund/-' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "amount": 0,
    "transactionId": "string",
    "currency": "string",
    "walletId": "string",
    "accountNumber": "string"
}'

Responses

🟢200OK

application/json

Body

transaction

object

optional

transactionId

string

optional

type

string

optional

amount

integer

optional

channel

string

optional

createdAt

string

optional

refundedTransactionId

string

optional

balance

integer

optional

Example

{
    "transaction": {
        "transactionId": "string",
        "type": "string",
        "amount": 0,
        "channel": "string",
        "createdAt": "string",
        "refundedTransactionId": "string"
    },
    "balance": 0
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2024-09-17 11:22:35

Spend

Cancel