Get the Financial File

Through this API it is possible to download the financial file.

Response Attributes

Name

Description

Details

id

File id.

string(16)

moipAccountId

Wirecard account id.

string(16)

createdAt

File creation date.

date

eventsCreatedAt

Date related to the settlement of financial entries.

date

type

File type. Possible value: FINANCIALS.

string(16)

count

Number of liquidated financial entries present in the file.

integer

_links

Resource links,

structured

└─file

Hyperlink to the file containing financial transactions in JSON format.

string

🚧

IMPORTANT

The API does not return the list of movements directly, but a link to a JSON file containing the list of movements. The link is in the _ links.file attribute.

The financial file is generated with the financial transactions from the previous day.

File Attributes

Name

Description

Details

id

File id.

string(16)

moipAccountId

Wirecard account id.

string(16)

createdAt

File creation date.

date

eventsCreatedAt

Date related to the settlement of financial entries.

date

type

File type. Possible value: FINANCIALS.

string(16)

settledEntries

Summary.

structured

├─summary

├───count

Number of liquidated financial entries present in the file.

integer

├───amount

Total value of financial entries.

integer

└───netAmount

integer

└─resources

List with the event type ENTRY.SETTLED.

list Resources

└──type

Entry type. See the type list.

string

📘

TIP

The attributes contained within the resources array follow the response pattern of the GETs of the Payments resource.

Financial File Example

{  
   "id":"REC-SHU2HRCRZ27F",
   "moipAccountId":"MPA-3748CA9C2940",
   "createdAt":"2019-01-08T09:39:44-0200",
   "eventsCreatedAt":"2018-12-14",
   "type":"FINANCIALS",
   "settledEntries":{  
      "summary":{  
         "count":9752, 
         "amount":-9759527, 
         "netAmount":-9759527 
      },
      "resources":[  
         {  
            "id":275318557,
            "externalId":"ENT-678T9VR45TYQ",
            "description":"Reembolso da Comissao do Pagamento PAY-LGHODG0JGHF5",
            "moipAccount":{  
               "account":"MPA-3748CA9C2940"
            },
            "grossAmount":-325, 
            "liquidAmount":-325, 
            "type":"COMMISSION_REFUND",
            "eventId":"REF-BMH5E4TMJ67J",
            "createdAt":"2018-12-14T23:12:39-0200",
            "updatedAt":"2018-12-14T23:12:39-0200",
            "settledAt":"2018-12-14T23:12:39-0200",
            "scheduledFor":"2018-12-13T10:18:37-0200",
            "fees":[  

            ],
            "references":[ 
               {  
                  "type":"PAYMENT",
                  "value":"PAY-LGHODG0JGHF5"
               },
               {  
                  "type":"OWN_ID",
                  "value":"TRA-726AF84FA19B473F9D7F4D381C9F04E4"
               },
               {  
                  "type":"ORDER",
                  "value":"ORD-U5C56VPGN0KG"
               },
               {  
                  "type":"REFUND",
                  "value":"REF-BMH5E4TMJ67J"
               }
            ],
            "installment":{  
               "amount":1,
               "number":1
            },
            "status":"SETTLED", 
            "reschedule":[  

            ]
         },
         {
        "id": 294054737,
        "externalId": "ENT-1GHNJPT3JUHY",
        "description": "Cartao de credito - Pedido PAY-IP6SGTDFYM2Y parcela 1 de 2",
        "moipAccount": {
          "account": "MPA-3748CA9C2940"
        },
        "grossAmount": 3863,
        "liquidAmount": 3709,
        "type": "CREDIT_CARD_INSTALLMENT", 
        "eventId": "PAY-IP6SGTDFYM2Y",
        "createdAt": "2019-04-10T21:13:44-0300",
        "updatedAt": "2019-05-10T02:17:40-0300",
        "settledAt": "2019-05-10T02:17:40-0300",
        "scheduledFor": "2019-05-10T21:13:44-0300",
        "fees": [
          {
            "amount": 154,
            "type": "TRANSACTION"
          }
        ],
        "references": [
          {
            "type": "ORDER",
            "value": "ORD-JUHVZPUFX234"
          },
          {
            "type": "OWN_ID",
            "value": "4194341242"
          },
          {
            "type": "PAYMENT",
            "value": "PAY-IP6SGTDFYM2Y"
          }
        ],
        "installment": {
          "amount": 2,
          "number": 1
        },
        "status": "SETTLED",
        "reschedule": []
      },
        {
        "id": 297528221,
        "externalId": "ENT-ENJPP74P3D16",
        "description": "Bloqueio de saldo - PAY-S9HY0L853Z5O",
        "moipAccount": {
          "account": "MPA-3748CA9C2940"
        },
        "grossAmount": -11982,
        "liquidAmount": -11982,
        "type": "AMOUNT_BLOCKED", 
        "eventId": "CBK-S8VE0L083Z1O",
        "createdAt": "2019-05-02T08:01:08-0300",
        "updatedAt": "2019-05-10T02:21:09-0300",
        "settledAt": "2019-05-10T02:21:09-0300",
        "scheduledFor": "2019-05-10T22:13:42-0300",
        "fees": [],
        "references": [
          {
            "type": "PAYMENT",
            "value": "PAY-S9HY0L853Z5O"
          }
        ],
        "installment": {
          "amount": 1,
          "number": 1
        },
        "status": "SETTLED",
        "reschedule": []
      }
      ]
   }
}
Language