Unload a Card

POST

https://{{env}}-lb.simplifipay.com/v1/card/{uuid}/unload

Card

The Unload a Card endpoint removes funds from an active card and moves them back to the Funding
source (Virtual account that holds the funds in certain currency).
Following are the properties of this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/card//unload' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestedAmount": "100.00",
    "comments": "string"
}'

Response Example

{
    "errorCode": "99997",
    "message": "General Error"
}

Request

Authorization

JWT

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

uuid

string

required

This field contains a unique identifier of the card.

Header Params

requestUuid

string

required

A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.

Example:

00d366f2-a6e9-4714-b172-02c4e58c29d8

Body Params application/json

requestedAmount

number

required

This field contains the amount that has been requested to be loaded onto a card.

Example:

100.00

comments

string

optional

Comments related to the load request

Examples

Responses

🟢200OK

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-27 12:44:57

Load a Card

Renewal of the Card