Get Standalone Credit Using Merchant Reference Number

GET 
/v1/standalonecredits

Click on Send API Request after entering the required data, to see how to lookup a Standalone Credit using the merchant reference number used in the original request.

Request

Query Parameters

merchantRefNum stringrequired

This is the merchant reference number created by the merchant and submitted as part of the Process Standalone Credit request.

limit number

Possible values: <= 50

Default value: 10

This is the total number of records to return.

offset number

Default value: 0

This is the starting position, where 0 is the first record.

startDate date

This is the start date in UTC. Default = 30 days before the endDate.

endDate date

This is the end date in UTC. Default = current date and time.

Responses

200

OK

Response Headers

• Content-Type

  string

application/json

Schema

Schema

standalonecredits object[]

meta

object

Contains meta info for the pagination APIs

numberOfRecords number

This is the number of records returned in the lookup.

limit number

This is the number of records returned per page.

page number

This is the page of records on which the lookup starts.

Example (from schema)

{
  "standalonecredits": [
    {
      "id": "25f6dadf-176a-415f-95c9-6ff39ff697ba",
      "paymentType": "CARD",
      "txnTime": "2023-01-19T10:48:04Z",
      "billingDetails": {
        "id": "string",
        "status": "string",
        "nickName": "Home",
        "street": "Street",
        "street1": "street1",
        "street2": "street2",
        "city": "Toronto",
        "state": "ON",
        "country": "CA",
        "zip": "M5H 2N2",
        "phone": "8765846321"
      },
      "status": "INITIATED",
      "returnLinks": [
        {
          "rel": "default",
          "href": "https://US_commerce_site/payment/return/success",
          "method": "GET"
        }
      ],
      "liveMode": true,
      "updatedTime": "2023-01-19T11:33:23Z",
      "statusTime": "2023-01-19T11:33:23Z",
      "profile": {
        "id": "string",
        "status": "string",
        "merchantCustomerId": "string",
        "locale": "en_US",
        "firstName": "Venkata Suresh",
        "lastName": "Chagalamarri",
        "email": "paysafe@gmail.com",
        "phone": "1234567891",
        "dateOfBirth": {
          "day": 6,
          "month": 5,
          "year": 1998
        },
        "mobile": "9846573804",
        "gender": "M",
        "nationality": "Indian",
        "identityDocuments": [
          {
            "identityDocuments": [
              {
                "type": "SOCIAL_SECURITY",
                "documentNumber": "SSN123456"
              },
              {
                "type": "PASSPORT",
                "documentNumber": "1234567",
                "issuingCountry": "USA",
                "issuingCountrySubdvision": "SA",
                "expiryDate": {
                  "month": 12,
                  "year": 2022
                }
              }
            ]
          }
        ]
      },
      "gatewayReconciliationId": "string",
      "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,
      "card": {
        "cardNum": "4111111111111111",
        "cardExpiry": {
          "month": 12,
          "year": 2022
        },
        "cvv": "string",
        "holderName": "Suresh's card",
        "cardType": "AM",
        "lastDigits": "string",
        "nickName": "string",
        "cardBin": "411111"
      }
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "page": 1
  }
}

Look Up a Standalone Credit Using Merchant Reference Number

{
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "page": 1
  },
  "standaloneCredits": [
    {
      "id": "eddbec36-6fc7-48fb-a694-dfc5b314ec0d",
      "amount": 500,
      "merchantRefNum": "32be35aac78dbfe252a2",
      "customerIp": "204.91.0.12",
      "txnTime": "2023-01-20T05:59:13Z",
      "currencyCode": "USD",
      "status": "PENDING",
      "description": "Winning payment from Loto 649",
      "paymentType": "CARD",
      "card": {
        "cardExpiry": {
          "month": "10",
          "year": "2025"
        },
        "cardType": "MC",
        "lastDigits": "0000"
      },
      "billingDetails": {
        "street": "TEST",
        "city": "CA",
        "country": "US",
        "state": "CA",
        "zip": "12345"
      }
    }
  ]
}

Loading...