Sign in

Link Payment ref to existing entity

PUT https://{organization}.myguper.com/api/register/{interface}/payment/{refId}

Links this refId to an existing entity (passed by paymentId). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.

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

{
    "paymentId": 42
}

Responses

{"id":42,"name":"Nike","_ref":{"source":"vtex","refId":"VTEX-NIKE-001"},"_linked":true}
Copied to clipboard