Skip to main content

standaloneCredit

Contains details of a standalone credit for a specific payment type

oneOf
card object

Card details to be used for the transaction

cardNumstringrequired

This is the card number used for the request.

Possible values: >= 8 characters and <= 20 characters

Example: 4111111111111111
cardExpiry object

This is the card's expiry date.

monthnumberrequired

This is the card expiry month.

Possible values: <= 12

Example: 12
yearnumberrequired

This is the card expiry year.

Possible values: <= 9999

Example: 2022
cvvstring

This is the 3- or 4-digit security code that appears on the card following the card number.

Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^([0-9]{3,4})$

holderNamestring

This is the name of the card holder.

Possible values: <= 50 characters

Example: Suresh's card
cardTypestring

This is type of card used for the request.

  • AM – American Express

  • DI – Discover

  • JC – JCB

  • MC – Mastercard

  • MD – Maestro

  • SO – Solo

  • VI – Visa

  • VD – Visa Debit

  • VE – Visa Electron

Possible values: [AM, DI, JC, MC, MD, SO, VI, VD, VE]

lastDigitsstring

These are the last four digits of the card used for the request.

nickNamestring

This is the nickname the merchant has for the card holder.

cardBinstring

These are the first 6 digits of the card Bank Identification Number (BIN), for example: the first 6 digits of the card number.

Possible values: <= 6 characters

Example: 411111
idstring

This is the ID returned in the response. This ID can be used for future associated requests.

Possible values: <= 36 characters

Example: 25f6dadf-176a-415f-95c9-6ff39ff697ba
paymentTypestring

This is the payment type associated with the Payment Handle used for this request.

Possible values: [CARD, BANK_TRANSFER, ACH]

txnTimestring<date-time>

This is the date and time the transaction was processed.

Example: 2023-01-19T10:48:04Z
billingDetails object

Customer's billing details.

Note: For single-use Payment Handles, this address information will be ignored if the paymentHandleTokenFrom parameter is included in the Payment Handle creation request and there is already address information associated with that customer.

idstring

This is the ID of the billing address, returned in the response.

Possible values: <= 36 characters

statusstring

This is the status of the address.

nickNamestring

This is the nickname the merchant has for the billing address.

Possible values: <= 50 characters

Example: Home
streetstringrequired

This is the first line of the customer's street address.

Possible values: <= 50 characters

Example: Street
street1string

This is the first line of the street address.

Note: Mandatory for VIPPreferred

Possible values: <= 50 characters

Example: street1
street2string

This is the second line of the street address, if required (e.g., apartment number).

Possible values: <= 50 characters

Example: street2
citystringrequired

This is the city where the address is located.

Possible values: <= 40 characters

Example: Toronto
statestring

This is the state/province/region in which the customer lives.

Possible values: >= 2 characters and <= 40 characters

Example: ON
countrystringrequired

This is the country where the address is located. See Country Codes.

Possible values: >= 2 characters and <= 2 characters

Example: CA
zipstringrequired

This is the zip, postal, or post code of the customer's address.

Possible values: <= 10 characters

Example: M5H 2N2
phonestring

This is the customer's telephone number.

Possible values: <= 40 characters

Example: 8765846321
statusstring

This is the status of the payment handle. Possible values are:

  • INITIATED – The transaction was initiated with the downstream provider.

  • PENDING - The transaction awaiting payment service provider's response.

  • FAILED – The transaction failed due to either an error or being declined.

  • CANCELLED - The authorization request has been fully reversed.

  • EXPIRED – The transaction request is expired.

  • COMPLETED – The transaction request is completed.

  • RECEIVED – Our system has received the request and is waiting for the downstream processor’s response.

Possible values: [INITIATED, PENDING, FAILED, CANCELLED, EXPIRED, COMPLETED, RECEIVED]

returnLinks object[]
  • Array [
    • relstringrequired

    This is the link type that allows different endpoints to be targeted depending on the end state of the transaction.

    • on_completed - Paysafe will return to this merchant url post successful payment.

    • on_failed - Paysafe will return to this merchant url post if payment is failed.

    • on_cancelled - Paysafe will return to this merchant url post if payment is cancelled.

    • default - The default return URL that will be used if specific status return URL is not defined.

    Possible values: [default, on_completed, on_failed, on_cancelled]

    hrefstringrequired

    This is the URI of the resource.

    Example: https://US_commerce_site/payment/return/success
    methodstringrequired

    This is the HTTP method.

    Example: GET
  • ]
    • liveModeboolean

    This flag indicates the environment.

    • true - Production
    • false - Non-Production
    updatedTimestring<date-time>

    ISO 8601 format (UTC). This is the date and time the resource was last updated.

    Example: 2023-01-19T11:33:23Z
    statusTimestring<date-time>

    ISO 8601 format (UTC). This is the date and time the resource was last updated.

    Example: 2023-01-19T11:33:23Z
    profile object

    This is customer's profile details.

    idstring

    The customer's profile id in the system. If this is present rest all other fields are not required.

    statusstring

    The status of customer in the system, returned in the response.

    merchantCustomerIdstring

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

    Note: This value is mandatory when fundingTransaction is used.

    Possible values: <= 10 characters

    localestringrequired

    This indicates the customer's locale preference.

    Note: Optional for GiroPay, Vippreferred-Direct-Registration. Not required for Paysafe Card Payouts.

    Possible values: [en_US, fr_CA, en_GB, en_CA]

    firstNamestringrequired

    This is the customer’s first name.

    Possible values: <= 80 characters

    Example: Venkata Suresh
    lastNamestringrequired

    This is the customer’s last name.

    Possible values: <= 80 characters

    Example: Chagalamarri
    emailstringrequired

    This is the customer's email address.

    Possible values: <= 255 characters

    Example: paysafe@gmail.com
    phonestring

    This is the customer's phone number.

    Note: Optional for GiroPay. Not required for Paysafe Card Payouts.

    Possible values: <= 40 characters

    Example: 1234567891
    dateOfBirth object

    This is the recipient's date of birth.

    daynumberrequired

    This is the day of birth.

    Possible values: <= 31

    Example: 6
    monthnumberrequired

    This is the month of birth.

    Possible values: <= 12

    Example: 5
    yearnumberrequired

    This is the year of birth.

    Possible values: >= 1900

    Example: 1998
    mobilestring

    Customer's mobile number.

    Possible values: <= 40 characters

    Example: 9846573804
    genderstring

    This field indicates the Customer's gender.

    M - Male

    F - Female

    Possible values: [M, F]

    Example: M
    nationalitystring

    This field indicates the Customer's nationality.

    Possible values: <= 30 characters

    Example: Indian
    identityDocuments object[]
  • Array [
    • identityDocuments object[]required

    This is array of 2 JSON objects.

    • 1st object contains SSN
    • 2nd object contains Identity document details.
  • Array [
    • anyOf
  • ]
  • ]
    • gatewayReconciliationIdstring

    Transaction identifier that can be used to reconcile this transaction with the provider gateway.

    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
    standaloneCredit
    {
      "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"
      }
    }