Sign in

Create payment method

POST https://{organization}.myguper.com/api/register/payment

Registers a payment method (register.payment row) for the organization. The controller accepts both the canonical field names (id, name, type) and their VTEX-style aliases (paymentSystem, paymentSystemName, paymentSystemType); aliases win when both are sent. When name/type are omitted the values default to UNNAMED/UNTYPED.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "id": "1",                                                  // optional
    "name": "Pix",                                              // optional
    "type": "pix"                                               // optional
}

Responses

{
    "id": "1",
    "name": "Pix",
    "type": "pix"
}
Copied to clipboard