Skip to main content

Create a new transaction

POST /transactions

In order to create a new transaction, the merchant needs to send an HTTP request to the relario PAY API

Request Body required

Create a new transaction

  • paymentType string

    Possible values: [sms]

    The payment method used by the merchant's customer to buy the virtual good or service.

  • customerId string

    Unique token used by the merchant to identify its customer.

  • productId string

    Unique identifier of the virtual good or service that the merchant is selling. There can be maximum 5 product ids used.

  • productName string

    Title of the virtual good or service that the merchant is selling.

  • smsCount integer

    Number of SMS messages that the customer’s merchant needs to send in order to buy the virtual goods or service.

  • customerIpAddress string

    IP address of merchant’s customer.

  • customerMsisdn string

    Phone number of the merchant's customer that will be used to make the payment. Depending on the payment method, this is the phone number that the customer will use to send the SMS message(s).

  • customerMccmnc string

    The mobile network of the customer identified by the MCC and MNC values.

  • customerLanguage string

    The language of the customer. Legacy - this parameter is ignored for sms transactions.

Responses

Successful operation

Schema
  • paymentType string

    Possible values: [sms]

    The payment method used by the merchant's customer to buy the virtual good or service.

  • transactionId string

    Id of the transaction that has been created.

  • customerIpAddress string

    IP address of merchant’s customer.

  • customerMsisdn string

    Phone number of the merchant's customer that will be used to make the payment. Depending on the payment method, this is the phone number that the customer will use to send the SMS message(s).

  • customerMccmnc string

    The mobile network of the customer identified by the MCC and MNC values.

  • customerCountryCode string

    The origin country of the customer.

  • merchantId integer

    Merchant identifier in relario PAY system.

  • customerId string

    Unique token used by the merchant to identify its customer.

  • productId string

    Unique identifier of the virtual good or service that the merchant is selling.

  • productName string

    Title of the virtual good or service that the merchant is selling.

  • smsCount integer

    Number of SMS messages that the customer’s merchant needs to send in order to buy the virtual goods or service.

  • smsBody string

    The body of the SMS message(s) that the merchant’s customer has to send in order to make the payment.

  • iosClickToSmsUrl string

    The URL to be put in the HTML link to compose the SMS draft, for iOS devices.

  • androidClickToSmsUrl string

    The URL to be put in the HTML link to compose the SMS draft, for Android devices.

  • clickToCallUrl string

    The URL to be put in the HTML link to initiate the phone call.

  • phoneNumbersList string[]

    The list of phone numbers that the merchant’s customer has to send SMS message(s) to in order to make the payment.

  • phoneNumber string

    The phone number that the merchant’s customer has to call in order to make the payment.

  • status string

    Status of the transaction.

  • payments object[]

    The list of phone numbers that the merchant’s customer has to send SMS message(s) to in order to make the payment.

  • Array [
  • id integer

    Unique identifier for the payment.

  • transactionId string

    Id of the transaction.

  • cli MSISDN

    Phone number of the customer that will send the SMS messages.

  • ddi MSISDN

    The phone number that the customer called or sent SMS to, in order to make the payment.

  • smsBody string

    The body of the SMS message(s) that the merchant’s customer has to send in order to make the payment.

  • initiatedAt number

    The phone number that the customer called or sent SMS to, in order to make the payment.

  • billable boolean

    If this transaction is considered as billable.

  • ]
  • createdAt int64

    The timestamp when the resource was created.

  • updatedAt int64

    The timestamp when the resource was last updated.

Loading...