Skip to main content

standaloneCreditsRequest

merchantRefNumstringrequired

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

Possible values: <= 255 characters

Example: merchant ABC-444
paymentHandleTokenstringrequired

This is the payment token generated by Paysafe that will be used for the request.

Possible values: <= 36 characters

Example: 842778a0-03a2-11e9-8eb2-f2801f1b9fd1
amountnumberrequired

This is the amount of the request, in minor units. For example, to process US $10.99, this value should be 1099.

Note: The amount specified in the Credit request must match the amount specified in the Payment Handle request from which the paymentHandleToken is taken.

Example: 10098
currencyCodestringrequired

This is the currency of the merchant account, for example, USD or CAD. See Currency Codes.

Note: The currencyCode specified in the Credit request must match the currencyCode specified in the Payment Handle request from which the paymentHandleToken is taken.

Possible values: <= 3 characters

Example: BTC
customerIpstring

This is the customer's IP address.

Possible values: <= 39 characters

Example: 204.91.0.12
descriptionstring

This is a description of the transaction, provided by the merchant.

Possible values: <= 255 characters

Example: Winning payment from Loto
dupCheckboolean

This validates that this request is not a duplicate. A duplicate request is when the merchantRefNum has already been used in a previous request within the past 90 days.

Default value: true
standaloneCreditsRequest
{
  "merchantRefNum": "merchant ABC-444",
  "paymentHandleToken": "842778a0-03a2-11e9-8eb2-f2801f1b9fd1",
  "amount": 10098,
  "currencyCode": "BTC",
  "customerIp": "204.91.0.12",
  "description": "Winning payment from Loto",
  "dupCheck": true
}