Payment

Loads/Funds a card, no notification to the user(CH).

Name	Required	Definition
CustId	Y	Customer ID
ProgramId	Y	Program ID
Amount	Y	Amount in cents. $1.00 is passed as 100
ReasonDescription	N	Optional Description for funding the card. Will be linked to the transaction and available in reporting.
ClaimReferenceNumber	Y	Claim Reference Number
ClientGroupID	Y	Client Group ID

Authorization

Name
Bearer Token
Type
e865a1e59daa629a8ade53bdae8ae659
Description

Header

Name
Content-Type
Type
application/json
Description
Name
HEADER123
Type
Test
Description

Body

Name

raw

Type

json

Description

JSON

{
    "ServiceName": "Payment",
    "data": {
        "CustId": "20230226001",
        "ProgramId": "7311",
        "Amount": "1",
        "ReasonDescription": "Funding Request",
        "ClaimReferenceNumber": "1234567890",
        "ClientGroupID": "1234"
    }
}

Request

POST

https://YOURENDPOINT.virtualrx.co/jsonapi.php

curl
--location 'https://YOURENDPOINT.virtualrx.co/jsonapi.php' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer e865a1e59daa629a8ade53bdae8ae659' \
--data '{
    "ServiceName": "Payment",
    "data": {
        "CustId": "20230226001",
        "ProgramId": "7311",
        "Amount": "1",
        "ReasonDescription": "Funding Request",
        "ClaimReferenceNumber": "1234567890",
        "ClientGroupID": "1234"
    }
}'

Response200 OK

{
    "ResponseDetails": {
        "ServiceName": "Payment",
        "SessionId": "0E334399-4766-9CBD-D2F8-EE9E3724EDA0",
        "StatusCode": "0",
        "StatusName": "StatusOK",
        "StatusDescription": "NA",
        "ServiceDate": "2022-05-13 07:28:39",
        "ServiceId": "0E334399-4766-9CBD-D2F8-EE9E3724EDA0"
    },
    "ResponseParams": {
        "balance_before_transaction": "1",
        "balance_after_transaction": "2",
        "active_holds": "0"
    }
}

Possible Error Codes:

Status Code	Transaction Description	Description	API
70038	VRX Unload - DECLINED	The VoidPayment Failed as funds are not available on the card.	VoidPayment
80040	SQL Error	Error Processing the SQL query	Payment,VoidPayment
80000	Unknown Error	Connection issues with Upstream provider	Payment,VoidPayment
70063	LimitsViolation	Incorrect limits for the program hierarchy	Payment
70062	LimitsViolation	Incorrect limits for the program hierarchy	Payment
70061	LimitsViolation	Incorrect limits for the program hierarchy	Payment
70025	VRX Reload - DECLINED	The card being funded is not in activate status or is suspended.	Payment,VoidPayment
40001	VRX Unload - DECLINED	40001 (Insufficient Available balance)	VoidPayment
70000	VRX Reload - DECLINED	Could not get data (SQL error or connection issue with upstream provider)	Payment,VoidPayment
70022	VRX Reload - DECLINED	The card being funded hasn't been issued yet	Payment