Versão Graph API

Pagamento /{payment-id}

Os detalhes de um pagamento feito em um app com os pagamentos do Facebook.

Leitura

Explorador da Graph API
GET /v19.0/{payment-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{payment-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{payment-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{payment-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissões

  • Um token de acesso do app para o app que criou o pagamento é obrigatório.

Campos

Nome Descrição Tipo

id

A identificação do pagamento

string

user

Nome e sobrenome do consumidor junto com o id do usuário. Pode ser omitido em alguns casos.

User

request_id

O identificador único e opcional criado pelo app passou para a função JS (máximo de 255 caracteres)

string

application

O app associado a esse pagamento

App

actions

A lista de diferentes tipos de ação que ocorreram neste pagamento.

object[]

type

O tipo dessa ação específica. O type pode ser:

  • charge: indica que o tipo de ação realizada no pagamento foi uma cobrança. Se a cobrança tiver o status de concluída, você deverá executar o pedido.
  • refund: indica que o pagamento foi reembolsado e que o item vendido ao consumidor deve ser recolhido, se possível, pois você não receberá um pagamento pela transação.
  • chargeback: um chargeback é iniciado por um consumidor com o banco dele contestando o pagamento em questão. No caso de um chargeback, você deve retirar do cliente o item no jogo (se possível), pois você não receberá um pagamento pelo pedido.
  • chargeback_reversal: ocorre quando um chargeback é revertido retroativamente. Nesse caso, você deve reintegrar o item no jogo do consumidor (se possível), pois agora você receberá um pagamento pelo pedido.
  • decline: ocorre quando uma forma de pagamento usada para criar uma transação em pacote é recusada no momento de processar o pagamento. Você deve retirar do consumidor o item no jogo (se possível), pois não receberá um pagamento pelo pedido. Para obter mais informações sobre recusas e transações em pacote, acesse este artigo sobre como lidar com contestações e reembolsos.

string

status

O status dessa ação específica. O status pode ser:

  • initiated: indica que o pagamento foi iniciado, mas ainda não foi totalmente concluído. Você não deve executar um pedido desse tipo com o consumidor nem receber uma atualização em tempo real de um pagamento com esse status. No entanto, você receberá uma atualização em tempo real quando a transação correspondente for concluída. Os desenvolvedores podem ver um estado iniciado para determinadas formas de pagamento que exigem um tempo maior para serem finalizadas. Por exemplo, algumas exigem que o cliente preencha um formulário online, imprima um recibo e faça o pagamento offline em um banco.
  • completed: o status "concluída" significa que a ação foi concluída com sucesso. Se o tipo era uma cobrança, você deverá executar o pedido do consumidor nesse momento. Do mesmo modo, se o tipo de ação era um reembolso, você deverá retirar o item do consumidor.
  • failed: isso indica uma falha na ação para o tipo subjacente. Esse valor pode estar presente tanto para um tipo de ação de cobrança como para um tipo de ação de reembolso.

string

amount

O valor em dinheiro incluído na ação.

string

currency

A moeda do amount acima na ação.

string

time_created

Quando a ação ocorreu.

datetime

time_updated

Quando a ação foi atualizada pela última vez.

datetime

tax_amount

O valor deduzido do seu pagamento referente a todos os impostos pagos pelo Facebook. Se tax for igual a not_taxed ou already_paid, esse campo será omitido.

string

items

Os itens associados ao pagamento.

object[]

type

O tipo do item.

enum{IN_APP_PURCHASE, SUBSCRIPTION}

product

A URL do produto do item.

string

quantity

O número do item comprado.

integer

country

O código do país ISO do comprador, para fins fiscais.

string

tax

O parâmetro do imposto especifica se um pagamento está sujeito ao imposto (IVA ou imposto sobre venda) e, se estiver, como o imposto foi pago. Isso pode assumir os seguintes valores:

  • not_taxed: não há IVA nesse pagamento porque ele se originou fora da União Europeia.
  • already_paid: o imposto desse pagamento já foi pago pela operadora de celular do usuário ou por outra parte envolvida no processo.
  • tax_remitted: o Facebook pagou o IVA desse pagamento no seu nome. O valor do imposto será deduzido do seu pagamento. Clique aqui para mais informações.

  • tax_remitted_USMPF: o Facebook coletou e pagou o imposto sobre venda desse pagamento no seu nome. O valor do imposto será deduzido do seu pagamento, mas não afetará o pagamento líquido, pois o valor do imposto cobrado está incluído no preço do produto. Clique aqui para mais informações.

string

tax_country

O país determinado pelo Facebook para fins de cálculo de impostos dessa compra, dado como um código de país ISO 3166-1 alpha-2. Observação: o objetivo desse campo é apenas informar e não deve ser usado para novos cálculos nem para fins de reconciliação. Se tax for igual a not_taxed ou already_paid, esse campo será omitido.

string

created_time

O horário em que o pagamento foi originalmente criado.

string

payout_foreign_exchange_rate

A taxa de câmbio usada para calcular o valor do pagamento, que é feito em dólar.

float

disputes

Contém as informações relacionadas a uma contestação, incluindo o user_comment e o user_email, fornecidos pelo consumidor quando a contestação é iniciada. Além disso, contém o status atual da contestação, o horário em que ela foi criada e um motivo da resolução, se disponível.

object[]

user_comment

Comentário fornecido pelo consumidor quando a contestação é iniciada.

string

user_email

Email fornecido pelo consumidor quando a contestação é iniciada.

string

time_created

O horário em que a contestação foi criada.

datetime

status

Status atual da contestação.

enum{resolved, pending}

reason

O motivo dado pelo desenvolvedor ou pelo Facebook para resolver a contestação, depois de ela ter sido resolvida.

enum{pending, refunded_in_cash, granted_replacement_item, denied_refund, banned_user, refunded_by_facebook}

test

Parâmetro opcional que aparece quando um pagamento é feito por um testador de pagamento listado no painel do app. Isso representa uma transação que não foi cobrada ao instrumento de pagamento do consumidor

boolean

Publicação

Não é possível criar pagamentos com os pagamentos do Facebook.

Exclusão

Não é possível excluir pagamentos com essa API.

Atualização

Não é possível atualizar pagamentos com essa borda.

Bordas

Nome Descrição

/dispute

Atualiza o status de contestação de um pagamento.

/refunds

Reembolsa um pagamento.