Update Payment

1min
This endpoint will let you update the payment's metadata and description
PUT
Request
Path Params
id
String
required
ID of the payment to update
Body Parameters
description 
String
optional
the payments description
metadata
Object
optional
the metadata object
Curl
curl -X PUT -u sk_key:\
     -H "Content-Type: application/json" \
     -d '{"description ":"string","metadata":"Object"}' \
     "https://api.moyasar.com/v1/payments/{id}"
curl -X PUT -u sk_key:\
     -H "Content-Type: application/json" \
     -d '{"description ":"string","metadata":"Object"}' \
     "https://api.moyasar.com/v1/payments/{id}"
Responses
200
400
{
    "id": "611c028e-855c-425c-a4eb-ce1e06680000",
    "status": "paid",
    "amount": 4866,
    "fee": 0,
    "currency": "SAR",
    "refunded": 0,
    "refunded_at": null,
    "captured": 0,
    "captured_at": null,
    "voided_at": null,
    "description": "Order #1000",
    "amount_format": "48.66 SAR",
    "fee_format": "0.00 SAR",
    "refunded_format": "0.00 SAR",
    "captured_format": "0.00 SAR",
    "invoice_id": "d1ee74c2-a996-445e-8c3e-fa4581d94bee",
    "ip": "2.88.101.106",
    "callback_url": "https://checkout.moyasar.com/invoices/d1ee74c2-a996-445e-8c3e-fa4581d94bee",
    "created_at": "2023-04-16T18:27:04.730Z",
    "updated_at": "2023-04-16T18:27:10.251Z",
    "metadata": {
        "test": "4"
    },
    "source": {
        "type": "creditcard",
        "company": "visa",
        "name": "Abdullah Alrayes",
        "number": "XXXX-XXXX-XXXX-1111",
        "gateway_id": "moyasar_cc_4uWh6w1RfRT9KcUGUCxEScw",
        "reference_number": null,
        "token": null,
        "message": "Succeeded! (Test Environment)",
        "transaction_url": "https://api.moyasar.com/v1/transaction_auths/****************/form"
    }
}
{
    "id": "611c028e-855c-425c-a4eb-ce1e06680000",
    "status": "paid",
    "amount": 4866,
    "fee": 0,
    "currency": "SAR",
    "refunded": 0,
    "refunded_at": null,
    "captured": 0,
    "captured_at": null,
    "voided_at": null,
    "description": "Order #1000",
    "amount_format": "48.66 SAR",
    "fee_format": "0.00 SAR",
    "refunded_format": "0.00 SAR",
    "captured_format": "0.00 SAR",
    "invoice_id": "d1ee74c2-a996-445e-8c3e-fa4581d94bee",
    "ip": "2.88.101.106",
    "callback_url": "https://checkout.moyasar.com/invoices/d1ee74c2-a996-445e-8c3e-fa4581d94bee",
    "created_at": "2023-04-16T18:27:04.730Z",
    "updated_at": "2023-04-16T18:27:10.251Z",
    "metadata": {
        "test": "4"
    },
    "source": {
        "type": "creditcard",
        "company": "visa",
        "name": "Abdullah Alrayes",
        "number": "XXXX-XXXX-XXXX-1111",
        "gateway_id": "moyasar_cc_4uWh6w1RfRT9KcUGUCxEScw",
        "reference_number": null,
        "token": null,
        "message": "Succeeded! (Test Environment)",
        "transaction_url": "https://api.moyasar.com/v1/transaction_auths/****************/form"
    }
}
﻿
﻿
Updated 23 Nov 2023
Did this page help you?
STC Pay Source
Fetch Payment