Skip to main content

Process Standalone Credit

POST 
/v1/standalonecredits

Standalone Credits allow merchants to issue credits to cardholders without requiring a previous Payment/Settlement.

Click on Send API Request after entering the required data, to see how to process a Standalone Credit request.

Note: If your merchant category code (MCC) is listed to process Original Credits, you must not use Standalone Credits.

Request​

Header Parameters

    Content-Type string

    Possible values: [application/json]

    Simulator string

    Possible values: [EXTERNAL, INTERNAL]

    Default value: EXTERNAL

Body

    merchantRefNum stringrequired

    Possible values: <= 255 characters

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

    paymentHandleToken stringrequired

    Possible values: <= 36 characters

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

    amount numberrequired

    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.

    currencyCode stringrequired

    Possible values: <= 3 characters

    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.

    customerIp string

    Possible values: <= 39 characters

    This is the customer's IP address.

    description string

    Possible values: <= 255 characters

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

    dupCheck boolean

    Default value: true

    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.

Responses​

Created

Response Headers

  • Content-Type

    string

Schema

    oneOf

    card

    object

    Card details to be used for the transaction

    cardNum stringrequired

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

    This is the card number used for the request.

    cardExpiry

    object

    This is the card's expiry date.

    month numberrequired

    Possible values: <= 12

    This is the card expiry month.

    year numberrequired

    Possible values: <= 9999

    This is the card expiry year.

    cvv string

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

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

    holderName string

    Possible values: <= 50 characters

    This is the name of the card holder.

    cardType string

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

    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

    lastDigits string

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

    nickName string

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

    cardBin string

    Possible values: <= 6 characters

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

    id string

    Possible values: <= 36 characters

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

    paymentType string

    Possible values: [CARD, BANK_TRANSFER, ACH]

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

    txnTime date-time

    This is the date and time the transaction was processed.

    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.

    id string

    Possible values: <= 36 characters

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

    status string

    This is the status of the address.

    nickName string

    Possible values: <= 50 characters

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

    street stringrequired

    Possible values: <= 50 characters

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

    street1 string

    Possible values: <= 50 characters

    This is the first line of the street address.

    Note: Mandatory for VIPPreferred

    street2 string

    Possible values: <= 50 characters

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

    city stringrequired

    Possible values: <= 40 characters

    This is the city where the address is located.

    state string

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

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

    country stringrequired

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

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

    zip stringrequired

    Possible values: <= 10 characters

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

    phone string

    Possible values: <= 40 characters

    This is the customer's telephone number.

    status string

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

    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.

    returnLinks

    object[]

  • Array [

    • rel stringrequired

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

    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.

    href stringrequired

    This is the URI of the resource.

    method stringrequired

    This is the HTTP method.

  • ]

    • liveMode boolean

    This flag indicates the environment.

    • true - Production
    • false - Non-Production
    updatedTime date-time

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

    statusTime date-time

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

    profile

    object

    This is customer's profile details.

    id string

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

    status string

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

    merchantCustomerId string

    Possible values: <= 10 characters

    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.

    locale stringrequired

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

    This indicates the customer's locale preference.

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

    firstName stringrequired

    Possible values: <= 80 characters

    This is the customer’s first name.

    lastName stringrequired

    Possible values: <= 80 characters

    This is the customer’s last name.

    email stringrequired

    Possible values: <= 255 characters

    This is the customer's email address.

    phone string

    Possible values: <= 40 characters

    This is the customer's phone number.

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

    dateOfBirth

    object

    This is the recipient's date of birth.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    mobile string

    Possible values: <= 40 characters

    Customer's mobile number.

    gender string

    Possible values: [M, F]

    This field indicates the Customer's gender.

    M - Male

    F - Female

    nationality string

    Possible values: <= 30 characters

    This field indicates the Customer's nationality.

    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

    type stringrequired

    Possible values: [SOCIAL_SECURITY]

    Default value: SOCIAL_SECURITY

    Value will always be "SOCIAL_SECURITY" This is part of 1st JSON object.

    documentNumber stringrequired

    Possible values: <= 9 characters

    The customer’s social security number.

  • ]

  • ]

    • gatewayReconciliationId string

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

    merchantRefNum stringrequired

    Possible values: <= 255 characters

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

    paymentHandleToken stringrequired

    Possible values: <= 36 characters

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

    amount numberrequired

    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.

    currencyCode stringrequired

    Possible values: <= 3 characters

    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.

    customerIp string

    Possible values: <= 39 characters

    This is the customer's IP address.

    description string

    Possible values: <= 255 characters

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

    dupCheck boolean

    Default value: true

    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.

Loading...