Token Payment

1min
Use this endpoint to create payment requests using tokenized cards
POST
Request
Body Parameters
amount
required
Integer
Amount intended to be collected by this payment. A positive integer represents how much to charge in the smallest currency unit (e.g., 100 Halala to charge 1.00 SAR or 100 to charge ¥100, a zero-decimal currency). The minimum amount is 1 SAR or equivalent in charge currency. 
currnecy
optional
String
3-letter ISO code for currency. E.g., SAR, CAD, USD. (default: SAR)
description
optional
String
An arbitrary string that you can attach to a payment object. The description is only for your reference and it is NOT displayed to users.
callback_url
required
String
The URL of the customer’s website page to be redirected to when using the payment form method or after a 3-D secure transaction (e.g., https://example.com/orders) 
source
required
Object
A payment source object to be charged, such as Apple Pay source, Credit Card source, or STC pay source. The details are described below. ('creditcard' for this example)
metadata
optional
Object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
Curl
curl -X POST https://api.moyasar.com/v1/payments \
     -u pk_test_MrtwozLJAuFmLKWWSaRaoaLX: \
     -d amount="60000" \
     -d currency="SAR" \
     -d description="Payment for Kindle Paperwhite" \
     -d callback_url="https://mystore.com/verify-payment" \
     -d source['type']="token"\
     -d source['token']="token_b869ce1iUidxhrh74257S891wvW481f"
curl -X POST https://api.moyasar.com/v1/payments \
     -u pk_test_MrtwozLJAuFmLKWWSaRaoaLX: \
     -d amount="60000" \
     -d currency="SAR" \
     -d description="Payment for Kindle Paperwhite" \
     -d callback_url="https://mystore.com/verify-payment" \
     -d source['type']="token"\
     -d source['token']="token_b869ce1iUidxhrh74257S891wvW481f"
Responses
201
400
{
  "id": "760878ec-d1d3-5f72-9056-191683f55872",
  "status": "paid",
  "amount": 60000,
  "fee": 1580,
  "currency": "SAR",
  "refunded": 0,
  "refunded_at": null,
  "captured": 0,
  "captured_at": null,
  "voided_at": null,
  "description": null,
  "amount_format": "600 SAR",
  "fee_format": "15.80 SAR",
  "refunded_format": "0.00 SAR",
  "captured_format": "0.00 SAR",
  "invoice_id": "9785ba96-a1be-5b13-a281-b27a4a6dad39",
  "ip": null,
  "callback_url": null,
  "created_at": "2016-05-11T17:04:17.000Z",
  "updated_at": "2016-05-12T17:04:19.633Z",
  "metadata": null,
  "source": {
    "type": "creditcard",
    "company": "visa",
    "name": "Saleh Ali",
    "number": "XXXX-XXXX-XXXX-1111",
    "message": null,
    "transaction_url": null,
    "gateway_id": "moyasar_cc_ce1iUidxhrh74257S891wvW",
    "reference_number": "125478454231"
  }
}
{
  "id": "760878ec-d1d3-5f72-9056-191683f55872",
  "status": "paid",
  "amount": 60000,
  "fee": 1580,
  "currency": "SAR",
  "refunded": 0,
  "refunded_at": null,
  "captured": 0,
  "captured_at": null,
  "voided_at": null,
  "description": null,
  "amount_format": "600 SAR",
  "fee_format": "15.80 SAR",
  "refunded_format": "0.00 SAR",
  "captured_format": "0.00 SAR",
  "invoice_id": "9785ba96-a1be-5b13-a281-b27a4a6dad39",
  "ip": null,
  "callback_url": null,
  "created_at": "2016-05-11T17:04:17.000Z",
  "updated_at": "2016-05-12T17:04:19.633Z",
  "metadata": null,
  "source": {
    "type": "creditcard",
    "company": "visa",
    "name": "Saleh Ali",
    "number": "XXXX-XXXX-XXXX-1111",
    "message": null,
    "transaction_url": null,
    "gateway_id": "moyasar_cc_ce1iUidxhrh74257S891wvW",
    "reference_number": "125478454231"
  }
}
﻿
﻿
Updated 28 Feb 2024
Did this page help you?
STC Pay Payment
Payment Validations