Payment

Create Payment Request

Changed on

Create a payment request for the provided identity.

post/v2/identities/{identifier}/payment-request

Request

  • The document declares no server URL.
  • Auth
    HTTP basic

Path parameters

identifierstring required

Issuer identifier

Request body

optionIDstring required
schemaIDstring required
descriptionstring required
userDIDstring required

Example request

{
  "description": "Payment for AML",
  "userDID": "<user did>"
}

Response

Payment Request Created

idstring uuid required
issuerDIDstring required
userDIDstring required
paymentOptionIDstring uuid required
paymentsPaymentRequestInfo[] required
createdAtstring date-time required
modifiedAtstring date-time required
status'not-verified' | 'success' | 'failed' | 'pending' | 'canceled' required
paidNoncestring
schemaIDstring uuid

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status