POST
/
facipaypartner
/
createPaymentOrder
Criar ordem de pagamento
curl --request POST \
  --url https://sandbox.api.faciconnect.com/facipaypartner/createPaymentOrder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalTransactionId": "order_8f2c1a9e-3b4d-4f2a-9c1e-2a7b6d5e4f30",
  "clientId": "usr_4821",
  "applicationUUID": "<string>",
  "name": "Compra Wow Media Store",
  "amount": 15000,
  "quantity": 1,
  "image": "<string>",
  "additionalInfo": "{\"returnUrl\":\"https://loja/sucesso\",\"cancelUrl\":\"https://loja/cancelado\",\"webhookUrl\":\"https://loja/api/facipay/webhook\"}"
}
'
{
  "code": 200,
  "message": "OK",
  "data": {
    "referenceNumber": "987654321"
  }
}

Autorizações

​
Authorization
string
header
obrigatório

Access token obtido em POST /token.

Cabeçalhos

​
Accept-Language
enum<string>
padrão:pt

Idioma das mensagens (pt, en, fr).

Opções disponíveis:
pt,
en,
fr

Corpo

application/json
​
externalTransactionId
string
obrigatório

ID único da ordem no seu sistema. Chave de idempotência.

Exemplo:

"order_8f2c1a9e-3b4d-4f2a-9c1e-2a7b6d5e4f30"

​
clientId
string
obrigatório

ID estável do cliente/sessão, persistente entre tentativas.

Exemplo:

"usr_4821"

​
applicationUUID
string
obrigatório

A publishableKey sem o prefixo pk_test_/pk_live_.

​
name
string
obrigatório

Descrição curta da compra (mostrada ao cliente).

Exemplo:

"Compra Wow Media Store"

​
amount
integer
obrigatório

Valor total em AOA, inteiro sem decimais.

Exemplo:

15000

​
quantity
integer
obrigatório
Exemplo:

1

​
image
string | null

URL opcional de uma imagem do produto/compra.

​
additionalInfo
string

String contendo um JSON com os URLs de retorno e webhook. Ex.: "{\"returnUrl\":\"https://loja/sucesso\",\"cancelUrl\":\"https://loja/cancelado\",\"webhookUrl\":\"https://loja/api/facipay/webhook\"}"

Exemplo:

"{\"returnUrl\":\"https://loja/sucesso\",\"cancelUrl\":\"https://loja/cancelado\",\"webhookUrl\":\"https://loja/api/facipay/webhook\"}"

Resposta

Ordem criada.

​
code
integer
Exemplo:

200

​
message
string
Exemplo:

"OK"

​
data
object